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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2779563003: Api-roll 47: 2017-03-27 (Closed)
Patch Set: Created 3 years, 8 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/storage__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/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 } 7 }
8 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://spanner.googleapis.com/", 12 "baseUrl": "https://spanner.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "canonicalName": "Spanner", 14 "canonicalName": "Spanner",
15 "description": "Cloud Spanner is a managed, mission-critical, globally consi stent and scalable relational database service.", 15 "description": "Cloud Spanner is a managed, mission-critical, globally consi stent and scalable relational database service.",
16 "discoveryVersion": "v1", 16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/spanner/", 17 "documentationLink": "https://cloud.google.com/spanner/",
18 "icons": { 18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", 19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" 20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 }, 21 },
22 "id": "spanner:v1", 22 "id": "spanner:v1",
23 "kind": "discovery#restDescription", 23 "kind": "discovery#restDescription",
24 "name": "spanner", 24 "name": "spanner",
25 "ownerDomain": "google.com", 25 "ownerDomain": "google.com",
26 "ownerName": "Google", 26 "ownerName": "Google",
27 "parameters": { 27 "parameters": {
28 "upload_protocol": { 28 "callback": {
29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 29 "description": "JSONP",
30 "location": "query", 30 "location": "query",
31 "type": "string" 31 "type": "string"
32 }, 32 },
33 "prettyPrint": {
34 "default": "true",
35 "description": "Returns response with indentations and line breaks." ,
36 "location": "query",
37 "type": "boolean"
38 },
39 "fields": {
40 "description": "Selector specifying which fields to include in a par tial response.",
41 "location": "query",
42 "type": "string"
43 },
44 "uploadType": {
45 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
46 "location": "query",
47 "type": "string"
48 },
49 "$.xgafv": { 33 "$.xgafv": {
50 "description": "V1 error format.", 34 "description": "V1 error format.",
51 "enum": [ 35 "enum": [
52 "1", 36 "1",
53 "2" 37 "2"
54 ], 38 ],
55 "enumDescriptions": [ 39 "enumDescriptions": [
56 "v1 error format", 40 "v1 error format",
57 "v2 error format" 41 "v2 error format"
58 ], 42 ],
59 "location": "query", 43 "location": "query",
60 "type": "string" 44 "type": "string"
61 }, 45 },
62 "callback": {
63 "description": "JSONP",
64 "location": "query",
65 "type": "string"
66 },
67 "alt": { 46 "alt": {
68 "default": "json", 47 "default": "json",
69 "description": "Data format for response.", 48 "description": "Data format for response.",
70 "enum": [ 49 "enum": [
71 "json", 50 "json",
72 "media", 51 "media",
73 "proto" 52 "proto"
74 ], 53 ],
75 "enumDescriptions": [ 54 "enumDescriptions": [
76 "Responses with Content-Type of application/json", 55 "Responses with Content-Type of application/json",
77 "Media download with context-dependent Content-Type", 56 "Media download with context-dependent Content-Type",
78 "Responses with Content-Type of application/x-protobuf" 57 "Responses with Content-Type of application/x-protobuf"
79 ], 58 ],
80 "location": "query", 59 "location": "query",
81 "type": "string" 60 "type": "string"
82 }, 61 },
62 "key": {
63 "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.",
64 "location": "query",
65 "type": "string"
66 },
83 "access_token": { 67 "access_token": {
84 "description": "OAuth access token.", 68 "description": "OAuth access token.",
85 "location": "query", 69 "location": "query",
86 "type": "string" 70 "type": "string"
87 }, 71 },
88 "key": {
89 "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.",
90 "location": "query",
91 "type": "string"
92 },
93 "quotaUser": { 72 "quotaUser": {
94 "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.", 73 "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.",
95 "location": "query", 74 "location": "query",
96 "type": "string" 75 "type": "string"
97 }, 76 },
98 "pp": { 77 "pp": {
99 "default": "true", 78 "default": "true",
100 "description": "Pretty-print response.", 79 "description": "Pretty-print response.",
101 "location": "query", 80 "location": "query",
102 "type": "boolean" 81 "type": "boolean"
103 }, 82 },
83 "bearer_token": {
84 "description": "OAuth bearer token.",
85 "location": "query",
86 "type": "string"
87 },
104 "oauth_token": { 88 "oauth_token": {
105 "description": "OAuth 2.0 token for the current user.", 89 "description": "OAuth 2.0 token for the current user.",
106 "location": "query", 90 "location": "query",
107 "type": "string" 91 "type": "string"
108 }, 92 },
109 "bearer_token": { 93 "upload_protocol": {
110 "description": "OAuth bearer token.", 94 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
95 "location": "query",
96 "type": "string"
97 },
98 "prettyPrint": {
99 "default": "true",
100 "description": "Returns response with indentations and line breaks." ,
101 "location": "query",
102 "type": "boolean"
103 },
104 "uploadType": {
105 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
106 "location": "query",
107 "type": "string"
108 },
109 "fields": {
110 "description": "Selector specifying which fields to include in a par tial response.",
111 "location": "query", 111 "location": "query",
112 "type": "string" 112 "type": "string"
113 } 113 }
114 }, 114 },
115 "protocol": "rest", 115 "protocol": "rest",
116 "resources": { 116 "resources": {
117 "projects": { 117 "projects": {
118 "resources": { 118 "resources": {
119 "instanceConfigs": {
120 "methods": {
121 "list": {
122 "description": "Lists the supported instance configu rations for a given project.",
123 "httpMethod": "GET",
124 "id": "spanner.projects.instanceConfigs.list",
125 "parameterOrder": [
126 "parent"
127 ],
128 "parameters": {
129 "pageToken": {
130 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
131 "location": "query",
132 "type": "string"
133 },
134 "pageSize": {
135 "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.",
136 "format": "int32",
137 "location": "query",
138 "type": "integer"
139 },
140 "parent": {
141 "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>`.",
142 "location": "path",
143 "pattern": "^projects/[^/]+$",
144 "required": true,
145 "type": "string"
146 }
147 },
148 "path": "v1/{+parent}/instanceConfigs",
149 "response": {
150 "$ref": "ListInstanceConfigsResponse"
151 },
152 "scopes": [
153 "https://www.googleapis.com/auth/cloud-platform"
154 ]
155 },
156 "get": {
157 "description": "Gets information about a particular instance configuration.",
158 "httpMethod": "GET",
159 "id": "spanner.projects.instanceConfigs.get",
160 "parameterOrder": [
161 "name"
162 ],
163 "parameters": {
164 "name": {
165 "description": "Required. The name of the re quested instance configuration. Values are of\nthe form `projects/<project>/inst anceConfigs/<config>`.",
166 "location": "path",
167 "pattern": "^projects/[^/]+/instanceConfigs/ [^/]+$",
168 "required": true,
169 "type": "string"
170 }
171 },
172 "path": "v1/{+name}",
173 "response": {
174 "$ref": "InstanceConfig"
175 },
176 "scopes": [
177 "https://www.googleapis.com/auth/cloud-platform"
178 ]
179 }
180 }
181 },
182 "instances": { 119 "instances": {
183 "methods": { 120 "methods": {
184 "setIamPolicy": {
185 "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `sp anner.instances.setIamPolicy` on\nresource.",
186 "httpMethod": "POST",
187 "id": "spanner.projects.instances.setIamPolicy",
188 "parameterOrder": [
189 "resource"
190 ],
191 "parameters": {
192 "resource": {
193 "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.",
194 "location": "path",
195 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
196 "required": true,
197 "type": "string"
198 }
199 },
200 "path": "v1/{+resource}:setIamPolicy",
201 "request": {
202 "$ref": "SetIamPolicyRequest"
203 },
204 "response": {
205 "$ref": "Policy"
206 },
207 "scopes": [
208 "https://www.googleapis.com/auth/cloud-platform"
209 ]
210 },
211 "create": {
212 "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. ",
213 "httpMethod": "POST",
214 "id": "spanner.projects.instances.create",
215 "parameterOrder": [
216 "parent"
217 ],
218 "parameters": {
219 "parent": {
220 "description": "Required. The name of the pr oject in which to create the instance. Values\nare of the form `projects/<projec t>`.",
221 "location": "path",
222 "pattern": "^projects/[^/]+$",
223 "required": true,
224 "type": "string"
225 }
226 },
227 "path": "v1/{+parent}/instances",
228 "request": {
229 "$ref": "CreateInstanceRequest"
230 },
231 "response": {
232 "$ref": "Operation"
233 },
234 "scopes": [
235 "https://www.googleapis.com/auth/cloud-platform"
236 ]
237 },
238 "getIamPolicy": {
239 "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.",
240 "httpMethod": "POST",
241 "id": "spanner.projects.instances.getIamPolicy",
242 "parameterOrder": [
243 "resource"
244 ],
245 "parameters": {
246 "resource": {
247 "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.",
248 "location": "path",
249 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
250 "required": true,
251 "type": "string"
252 }
253 },
254 "path": "v1/{+resource}:getIamPolicy",
255 "request": {
256 "$ref": "GetIamPolicyRequest"
257 },
258 "response": {
259 "$ref": "Policy"
260 },
261 "scopes": [
262 "https://www.googleapis.com/auth/cloud-platform"
263 ]
264 },
265 "patch": { 121 "patch": {
266 "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.", 122 "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.",
267 "httpMethod": "PATCH", 123 "httpMethod": "PATCH",
268 "id": "spanner.projects.instances.patch", 124 "id": "spanner.projects.instances.patch",
269 "parameterOrder": [ 125 "parameterOrder": [
270 "name" 126 "name"
271 ], 127 ],
272 "parameters": { 128 "parameters": {
273 "name": { 129 "name": {
274 "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.", 130 "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.",
(...skipping 90 matching lines...) Expand 10 before | Expand all | Expand 10 after
365 ] 221 ]
366 }, 222 },
367 "list": { 223 "list": {
368 "description": "Lists all instances in the given pro ject.", 224 "description": "Lists all instances in the given pro ject.",
369 "httpMethod": "GET", 225 "httpMethod": "GET",
370 "id": "spanner.projects.instances.list", 226 "id": "spanner.projects.instances.list",
371 "parameterOrder": [ 227 "parameterOrder": [
372 "parent" 228 "parent"
373 ], 229 ],
374 "parameters": { 230 "parameters": {
231 "filter": {
232 "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\".",
233 "location": "query",
234 "type": "string"
235 },
375 "pageToken": { 236 "pageToken": {
376 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token from a\nprevious ListInstancesResponse.", 237 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
377 "location": "query", 238 "location": "query",
378 "type": "string" 239 "type": "string"
379 }, 240 },
380 "pageSize": { 241 "pageSize": {
381 "description": "Number of instances to be re turned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.", 242 "description": "Number of instances to be re turned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
382 "format": "int32", 243 "format": "int32",
383 "location": "query", 244 "location": "query",
384 "type": "integer" 245 "type": "integer"
385 }, 246 },
386 "parent": { 247 "parent": {
387 "description": "Required. The name of the pr oject for which a list of instances is\nrequested. Values are of the form `proje cts/<project>`.", 248 "description": "Required. The name of the pr oject for which a list of instances is\nrequested. Values are of the form `proje cts/<project>`.",
388 "location": "path", 249 "location": "path",
389 "pattern": "^projects/[^/]+$", 250 "pattern": "^projects/[^/]+$",
390 "required": true, 251 "required": true,
391 "type": "string" 252 "type": "string"
392 },
393 "filter": {
394 "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\".",
395 "location": "query",
396 "type": "string"
397 } 253 }
398 }, 254 },
399 "path": "v1/{+parent}/instances", 255 "path": "v1/{+parent}/instances",
400 "response": { 256 "response": {
401 "$ref": "ListInstancesResponse" 257 "$ref": "ListInstancesResponse"
402 }, 258 },
403 "scopes": [ 259 "scopes": [
404 "https://www.googleapis.com/auth/cloud-platform" 260 "https://www.googleapis.com/auth/cloud-platform"
405 ] 261 ]
262 },
263 "setIamPolicy": {
264 "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `sp anner.instances.setIamPolicy` on\nresource.",
265 "httpMethod": "POST",
266 "id": "spanner.projects.instances.setIamPolicy",
267 "parameterOrder": [
268 "resource"
269 ],
270 "parameters": {
271 "resource": {
272 "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.",
273 "location": "path",
274 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
275 "required": true,
276 "type": "string"
277 }
278 },
279 "path": "v1/{+resource}:setIamPolicy",
280 "request": {
281 "$ref": "SetIamPolicyRequest"
282 },
283 "response": {
284 "$ref": "Policy"
285 },
286 "scopes": [
287 "https://www.googleapis.com/auth/cloud-platform"
288 ]
289 },
290 "create": {
291 "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. ",
292 "httpMethod": "POST",
293 "id": "spanner.projects.instances.create",
294 "parameterOrder": [
295 "parent"
296 ],
297 "parameters": {
298 "parent": {
299 "description": "Required. The name of the pr oject in which to create the instance. Values\nare of the form `projects/<projec t>`.",
300 "location": "path",
301 "pattern": "^projects/[^/]+$",
302 "required": true,
303 "type": "string"
304 }
305 },
306 "path": "v1/{+parent}/instances",
307 "request": {
308 "$ref": "CreateInstanceRequest"
309 },
310 "response": {
311 "$ref": "Operation"
312 },
313 "scopes": [
314 "https://www.googleapis.com/auth/cloud-platform"
315 ]
316 },
317 "getIamPolicy": {
318 "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.",
319 "httpMethod": "POST",
320 "id": "spanner.projects.instances.getIamPolicy",
321 "parameterOrder": [
322 "resource"
323 ],
324 "parameters": {
325 "resource": {
326 "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.",
327 "location": "path",
328 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
329 "required": true,
330 "type": "string"
331 }
332 },
333 "path": "v1/{+resource}:getIamPolicy",
334 "request": {
335 "$ref": "GetIamPolicyRequest"
336 },
337 "response": {
338 "$ref": "Policy"
339 },
340 "scopes": [
341 "https://www.googleapis.com/auth/cloud-platform"
342 ]
406 } 343 }
407 }, 344 },
408 "resources": { 345 "resources": {
409 "databases": { 346 "databases": {
410 "methods": { 347 "methods": {
348 "get": {
349 "description": "Gets the state of a Cloud Sp anner database.",
350 "httpMethod": "GET",
351 "id": "spanner.projects.instances.databases. get",
352 "parameterOrder": [
353 "name"
354 ],
355 "parameters": {
356 "name": {
357 "description": "Required. The name o f the requested database. Values are of the form\n`projects/<project>/instances/ <instance>/databases/<database>`.",
358 "location": "path",
359 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
360 "required": true,
361 "type": "string"
362 }
363 },
364 "path": "v1/{+name}",
365 "response": {
366 "$ref": "Database"
367 },
368 "scopes": [
369 "https://www.googleapis.com/auth/cloud-p latform"
370 ]
371 },
372 "dropDatabase": {
373 "description": "Drops (aka deletes) a Cloud Spanner database.",
374 "httpMethod": "DELETE",
375 "id": "spanner.projects.instances.databases. dropDatabase",
376 "parameterOrder": [
377 "database"
378 ],
379 "parameters": {
380 "database": {
381 "description": "Required. The databa se to be dropped.",
382 "location": "path",
383 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
384 "required": true,
385 "type": "string"
386 }
387 },
388 "path": "v1/{+database}",
389 "response": {
390 "$ref": "Empty"
391 },
392 "scopes": [
393 "https://www.googleapis.com/auth/cloud-p latform"
394 ]
395 },
411 "updateDdl": { 396 "updateDdl": {
412 "description": "Updates the schema of a Clou d Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `<database _name>/operations/<operation_id>` and can be used to\ntrack execution of the sch ema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The oper ation has no response.", 397 "description": "Updates the schema of a Clou d Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `<database _name>/operations/<operation_id>` and can be used to\ntrack execution of the sch ema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The oper ation has no response.",
413 "httpMethod": "PATCH", 398 "httpMethod": "PATCH",
414 "id": "spanner.projects.instances.databases. updateDdl", 399 "id": "spanner.projects.instances.databases. updateDdl",
415 "parameterOrder": [ 400 "parameterOrder": [
416 "database" 401 "database"
417 ], 402 ],
418 "parameters": { 403 "parameters": {
419 "database": { 404 "database": {
420 "description": "Required. The databa se to update.", 405 "description": "Required. The databa se to update.",
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after
487 ] 472 ]
488 }, 473 },
489 "list": { 474 "list": {
490 "description": "Lists Cloud Spanner database s.", 475 "description": "Lists Cloud Spanner database s.",
491 "httpMethod": "GET", 476 "httpMethod": "GET",
492 "id": "spanner.projects.instances.databases. list", 477 "id": "spanner.projects.instances.databases. list",
493 "parameterOrder": [ 478 "parameterOrder": [
494 "parent" 479 "parent"
495 ], 480 ],
496 "parameters": { 481 "parameters": {
482 "pageSize": {
483 "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
484 "format": "int32",
485 "location": "query",
486 "type": "integer"
487 },
497 "parent": { 488 "parent": {
498 "description": "Required. The instan ce whose databases should be listed.\nValues are of the form `projects/<project> /instances/<instance>`.", 489 "description": "Required. The instan ce whose databases should be listed.\nValues are of the form `projects/<project> /instances/<instance>`.",
499 "location": "path", 490 "location": "path",
500 "pattern": "^projects/[^/]+/instance s/[^/]+$", 491 "pattern": "^projects/[^/]+/instance s/[^/]+$",
501 "required": true, 492 "required": true,
502 "type": "string" 493 "type": "string"
503 }, 494 },
504 "pageToken": { 495 "pageToken": {
505 "description": "If non-empty, `page_ token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse. ", 496 "description": "If non-empty, `page_ token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse. ",
506 "location": "query", 497 "location": "query",
507 "type": "string" 498 "type": "string"
508 },
509 "pageSize": {
510 "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
511 "format": "int32",
512 "location": "query",
513 "type": "integer"
514 } 499 }
515 }, 500 },
516 "path": "v1/{+parent}/databases", 501 "path": "v1/{+parent}/databases",
517 "response": { 502 "response": {
518 "$ref": "ListDatabasesResponse" 503 "$ref": "ListDatabasesResponse"
519 }, 504 },
520 "scopes": [ 505 "scopes": [
521 "https://www.googleapis.com/auth/cloud-p latform" 506 "https://www.googleapis.com/auth/cloud-p latform"
522 ] 507 ]
523 }, 508 },
509 "setIamPolicy": {
510 "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.",
511 "httpMethod": "POST",
512 "id": "spanner.projects.instances.databases. setIamPolicy",
513 "parameterOrder": [
514 "resource"
515 ],
516 "parameters": {
517 "resource": {
518 "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.",
519 "location": "path",
520 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
521 "required": true,
522 "type": "string"
523 }
524 },
525 "path": "v1/{+resource}:setIamPolicy",
526 "request": {
527 "$ref": "SetIamPolicyRequest"
528 },
529 "response": {
530 "$ref": "Policy"
531 },
532 "scopes": [
533 "https://www.googleapis.com/auth/cloud-p latform"
534 ]
535 },
524 "create": { 536 "create": {
525 "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 .", 537 "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 .",
526 "httpMethod": "POST", 538 "httpMethod": "POST",
527 "id": "spanner.projects.instances.databases. create", 539 "id": "spanner.projects.instances.databases. create",
528 "parameterOrder": [ 540 "parameterOrder": [
529 "parent" 541 "parent"
530 ], 542 ],
531 "parameters": { 543 "parameters": {
532 "parent": { 544 "parent": {
533 "description": "Required. The name o f the instance that will serve the new database.\nValues are of the form `projec ts/<project>/instances/<instance>`.", 545 "description": "Required. The name o f the instance that will serve the new database.\nValues are of the form `projec ts/<project>/instances/<instance>`.",
534 "location": "path", 546 "location": "path",
535 "pattern": "^projects/[^/]+/instance s/[^/]+$", 547 "pattern": "^projects/[^/]+/instance s/[^/]+$",
536 "required": true, 548 "required": true,
537 "type": "string" 549 "type": "string"
538 } 550 }
539 }, 551 },
540 "path": "v1/{+parent}/databases", 552 "path": "v1/{+parent}/databases",
541 "request": { 553 "request": {
542 "$ref": "CreateDatabaseRequest" 554 "$ref": "CreateDatabaseRequest"
543 }, 555 },
544 "response": { 556 "response": {
545 "$ref": "Operation" 557 "$ref": "Operation"
546 }, 558 },
547 "scopes": [ 559 "scopes": [
548 "https://www.googleapis.com/auth/cloud-p latform" 560 "https://www.googleapis.com/auth/cloud-p latform"
549 ]
550 },
551 "setIamPolicy": {
552 "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.",
553 "httpMethod": "POST",
554 "id": "spanner.projects.instances.databases. setIamPolicy",
555 "parameterOrder": [
556 "resource"
557 ],
558 "parameters": {
559 "resource": {
560 "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.",
561 "location": "path",
562 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
563 "required": true,
564 "type": "string"
565 }
566 },
567 "path": "v1/{+resource}:setIamPolicy",
568 "request": {
569 "$ref": "SetIamPolicyRequest"
570 },
571 "response": {
572 "$ref": "Policy"
573 },
574 "scopes": [
575 "https://www.googleapis.com/auth/cloud-p latform"
576 ] 561 ]
577 }, 562 },
578 "getIamPolicy": { 563 "getIamPolicy": {
579 "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.", 564 "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.",
580 "httpMethod": "POST", 565 "httpMethod": "POST",
581 "id": "spanner.projects.instances.databases. getIamPolicy", 566 "id": "spanner.projects.instances.databases. getIamPolicy",
582 "parameterOrder": [ 567 "parameterOrder": [
583 "resource" 568 "resource"
584 ], 569 ],
585 "parameters": { 570 "parameters": {
586 "resource": { 571 "resource": {
587 "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.", 572 "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.",
588 "location": "path", 573 "location": "path",
589 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$", 574 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
590 "required": true, 575 "required": true,
591 "type": "string" 576 "type": "string"
592 } 577 }
593 }, 578 },
594 "path": "v1/{+resource}:getIamPolicy", 579 "path": "v1/{+resource}:getIamPolicy",
595 "request": { 580 "request": {
596 "$ref": "GetIamPolicyRequest" 581 "$ref": "GetIamPolicyRequest"
597 }, 582 },
598 "response": { 583 "response": {
599 "$ref": "Policy" 584 "$ref": "Policy"
600 }, 585 },
601 "scopes": [ 586 "scopes": [
602 "https://www.googleapis.com/auth/cloud-p latform" 587 "https://www.googleapis.com/auth/cloud-p latform"
603 ] 588 ]
604 },
605 "get": {
606 "description": "Gets the state of a Cloud Sp anner database.",
607 "httpMethod": "GET",
608 "id": "spanner.projects.instances.databases. get",
609 "parameterOrder": [
610 "name"
611 ],
612 "parameters": {
613 "name": {
614 "description": "Required. The name o f the requested database. Values are of the form\n`projects/<project>/instances/ <instance>/databases/<database>`.",
615 "location": "path",
616 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
617 "required": true,
618 "type": "string"
619 }
620 },
621 "path": "v1/{+name}",
622 "response": {
623 "$ref": "Database"
624 },
625 "scopes": [
626 "https://www.googleapis.com/auth/cloud-p latform"
627 ]
628 },
629 "dropDatabase": {
630 "description": "Drops (aka deletes) a Cloud Spanner database.",
631 "httpMethod": "DELETE",
632 "id": "spanner.projects.instances.databases. dropDatabase",
633 "parameterOrder": [
634 "database"
635 ],
636 "parameters": {
637 "database": {
638 "description": "Required. The databa se to be dropped.",
639 "location": "path",
640 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
641 "required": true,
642 "type": "string"
643 }
644 },
645 "path": "v1/{+database}",
646 "response": {
647 "$ref": "Empty"
648 },
649 "scopes": [
650 "https://www.googleapis.com/auth/cloud-p latform"
651 ]
652 } 589 }
653 }, 590 },
654 "resources": { 591 "resources": {
655 "operations": { 592 "operations": {
656 "methods": { 593 "methods": {
657 "cancel": {
658 "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`.",
659 "httpMethod": "POST",
660 "id": "spanner.projects.instances.da tabases.operations.cancel",
661 "parameterOrder": [
662 "name"
663 ],
664 "parameters": {
665 "name": {
666 "description": "The name of the operation resource to be cancelled.",
667 "location": "path",
668 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/operations/[^/]+$",
669 "required": true,
670 "type": "string"
671 }
672 },
673 "path": "v1/{+name}:cancel",
674 "response": {
675 "$ref": "Empty"
676 },
677 "scopes": [
678 "https://www.googleapis.com/auth /cloud-platform"
679 ]
680 },
681 "delete": {
682 "description": "Deletes a long-runni ng operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't s upport this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
683 "httpMethod": "DELETE",
684 "id": "spanner.projects.instances.da tabases.operations.delete",
685 "parameterOrder": [
686 "name"
687 ],
688 "parameters": {
689 "name": {
690 "description": "The name of the operation resource to be deleted.",
691 "location": "path",
692 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/operations/[^/]+$",
693 "required": true,
694 "type": "string"
695 }
696 },
697 "path": "v1/{+name}",
698 "response": {
699 "$ref": "Empty"
700 },
701 "scopes": [
702 "https://www.googleapis.com/auth /cloud-platform"
703 ]
704 },
705 "list": { 594 "list": {
706 "description": "Lists operations tha t match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows AP I services to override the binding\nto use different resource name schemes, such as `users/*/operations`.", 595 "description": "Lists operations tha t match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows AP I services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
707 "httpMethod": "GET", 596 "httpMethod": "GET",
708 "id": "spanner.projects.instances.da tabases.operations.list", 597 "id": "spanner.projects.instances.da tabases.operations.list",
709 "parameterOrder": [ 598 "parameterOrder": [
710 "name" 599 "name"
711 ], 600 ],
712 "parameters": { 601 "parameters": {
713 "filter": { 602 "filter": {
714 "description": "The standard list filter.", 603 "description": "The standard list filter.",
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
758 "type": "string" 647 "type": "string"
759 } 648 }
760 }, 649 },
761 "path": "v1/{+name}", 650 "path": "v1/{+name}",
762 "response": { 651 "response": {
763 "$ref": "Operation" 652 "$ref": "Operation"
764 }, 653 },
765 "scopes": [ 654 "scopes": [
766 "https://www.googleapis.com/auth /cloud-platform" 655 "https://www.googleapis.com/auth /cloud-platform"
767 ] 656 ]
657 },
658 "cancel": {
659 "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`.",
660 "httpMethod": "POST",
661 "id": "spanner.projects.instances.da tabases.operations.cancel",
662 "parameterOrder": [
663 "name"
664 ],
665 "parameters": {
666 "name": {
667 "description": "The name of the operation resource to be cancelled.",
668 "location": "path",
669 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/operations/[^/]+$",
670 "required": true,
671 "type": "string"
672 }
673 },
674 "path": "v1/{+name}:cancel",
675 "response": {
676 "$ref": "Empty"
677 },
678 "scopes": [
679 "https://www.googleapis.com/auth /cloud-platform"
680 ]
681 },
682 "delete": {
683 "description": "Deletes a long-runni ng operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't s upport this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
684 "httpMethod": "DELETE",
685 "id": "spanner.projects.instances.da tabases.operations.delete",
686 "parameterOrder": [
687 "name"
688 ],
689 "parameters": {
690 "name": {
691 "description": "The name of the operation resource to be deleted.",
692 "location": "path",
693 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/operations/[^/]+$",
694 "required": true,
695 "type": "string"
696 }
697 },
698 "path": "v1/{+name}",
699 "response": {
700 "$ref": "Empty"
701 },
702 "scopes": [
703 "https://www.googleapis.com/auth /cloud-platform"
704 ]
768 } 705 }
769 } 706 }
770 }, 707 },
771 "sessions": { 708 "sessions": {
772 "methods": { 709 "methods": {
773 "executeSql": {
774 "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.",
775 "httpMethod": "POST",
776 "id": "spanner.projects.instances.da tabases.sessions.executeSql",
777 "parameterOrder": [
778 "session"
779 ],
780 "parameters": {
781 "session": {
782 "description": "Required. Th e session in which the SQL query should be performed.",
783 "location": "path",
784 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
785 "required": true,
786 "type": "string"
787 }
788 },
789 "path": "v1/{+session}:executeSql",
790 "request": {
791 "$ref": "ExecuteSqlRequest"
792 },
793 "response": {
794 "$ref": "ResultSet"
795 },
796 "scopes": [
797 "https://www.googleapis.com/auth /cloud-platform"
798 ]
799 },
800 "rollback": {
801 "description": "Rolls back a transac tion, releasing any locks it holds. It is a good\nidea to call this for any tran saction that includes one or more\nRead or ExecuteSql requests and\nultimately d ecides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the t ransaction, the\ntransaction was already aborted, or the transaction is not\nfou nd. `Rollback` never returns `ABORTED`.",
802 "httpMethod": "POST",
803 "id": "spanner.projects.instances.da tabases.sessions.rollback",
804 "parameterOrder": [
805 "session"
806 ],
807 "parameters": {
808 "session": {
809 "description": "Required. Th e session in which the transaction to roll back is running.",
810 "location": "path",
811 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
812 "required": true,
813 "type": "string"
814 }
815 },
816 "path": "v1/{+session}:rollback",
817 "request": {
818 "$ref": "RollbackRequest"
819 },
820 "response": {
821 "$ref": "Empty"
822 },
823 "scopes": [
824 "https://www.googleapis.com/auth /cloud-platform"
825 ]
826 },
827 "streamingRead": {
828 "description": "Like Read, except re turns the result set as a\nstream. Unlike Read, there is no limit on the\nsize o f the returned result set. However, no individual row in\nthe result set can exc eed 100 MiB, and no column value can exceed\n10 MiB.",
829 "httpMethod": "POST",
830 "id": "spanner.projects.instances.da tabases.sessions.streamingRead",
831 "parameterOrder": [
832 "session"
833 ],
834 "parameters": {
835 "session": {
836 "description": "Required. Th e session in which the read should be performed.",
837 "location": "path",
838 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
839 "required": true,
840 "type": "string"
841 }
842 },
843 "path": "v1/{+session}:streamingRead ",
844 "request": {
845 "$ref": "ReadRequest"
846 },
847 "response": {
848 "$ref": "PartialResultSet"
849 },
850 "scopes": [
851 "https://www.googleapis.com/auth /cloud-platform"
852 ]
853 },
854 "create": {
855 "description": "Creates a new sessio n. A session can be used to perform\ntransactions that read and/or modify data i n a Cloud Spanner database.\nSessions are meant to be reused for many consecutiv e\ntransactions.\n\nSessions can only execute one transaction at a time. To exec ute\nmultiple concurrent read-write/write-only transactions, create\nmultiple se ssions. Note that standalone reads and queries use a\ntransaction internally, an d count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete i dle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can de lete sessions for\nwhich no operations are sent for more than an hour, or due to \ninternal errors. If a session is deleted, requests to it\nreturn `NOT_FOUND`.\ n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
856 "httpMethod": "POST",
857 "id": "spanner.projects.instances.da tabases.sessions.create",
858 "parameterOrder": [
859 "database"
860 ],
861 "parameters": {
862 "database": {
863 "description": "Required. Th e database in which the new session is created.",
864 "location": "path",
865 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+$",
866 "required": true,
867 "type": "string"
868 }
869 },
870 "path": "v1/{+database}/sessions",
871 "response": {
872 "$ref": "Session"
873 },
874 "scopes": [
875 "https://www.googleapis.com/auth /cloud-platform"
876 ]
877 },
878 "read": {
879 "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative t o\nExecuteSql. This method cannot be used to\nreturn a result set larger than 1 0 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_P RECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORT ED`. If\nthis occurs, the application should restart the transaction from\nthe b eginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.",
880 "httpMethod": "POST",
881 "id": "spanner.projects.instances.da tabases.sessions.read",
882 "parameterOrder": [
883 "session"
884 ],
885 "parameters": {
886 "session": {
887 "description": "Required. Th e session in which the read should be performed.",
888 "location": "path",
889 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
890 "required": true,
891 "type": "string"
892 }
893 },
894 "path": "v1/{+session}:read",
895 "request": {
896 "$ref": "ReadRequest"
897 },
898 "response": {
899 "$ref": "ResultSet"
900 },
901 "scopes": [
902 "https://www.googleapis.com/auth /cloud-platform"
903 ]
904 },
905 "get": { 710 "get": {
906 "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.", 711 "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.",
907 "httpMethod": "GET", 712 "httpMethod": "GET",
908 "id": "spanner.projects.instances.da tabases.sessions.get", 713 "id": "spanner.projects.instances.da tabases.sessions.get",
909 "parameterOrder": [ 714 "parameterOrder": [
910 "name" 715 "name"
911 ], 716 ],
912 "parameters": { 717 "parameters": {
913 "name": { 718 "name": {
914 "description": "Required. Th e name of the session to retrieve.", 719 "description": "Required. Th e name of the session to retrieve.",
915 "location": "path", 720 "location": "path",
916 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$", 721 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
917 "required": true, 722 "required": true,
918 "type": "string" 723 "type": "string"
919 } 724 }
920 }, 725 },
921 "path": "v1/{+name}", 726 "path": "v1/{+name}",
922 "response": { 727 "response": {
923 "$ref": "Session" 728 "$ref": "Session"
924 }, 729 },
925 "scopes": [ 730 "scopes": [
926 "https://www.googleapis.com/auth /cloud-platform" 731 "https://www.googleapis.com/auth /cloud-platform"
732 ]
733 },
734 "executeStreamingSql": {
735 "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.",
736 "httpMethod": "POST",
737 "id": "spanner.projects.instances.da tabases.sessions.executeStreamingSql",
738 "parameterOrder": [
739 "session"
740 ],
741 "parameters": {
742 "session": {
743 "description": "Required. Th e session in which the SQL query should be performed.",
744 "location": "path",
745 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
746 "required": true,
747 "type": "string"
748 }
749 },
750 "path": "v1/{+session}:executeStream ingSql",
751 "request": {
752 "$ref": "ExecuteSqlRequest"
753 },
754 "response": {
755 "$ref": "PartialResultSet"
756 },
757 "scopes": [
758 "https://www.googleapis.com/auth /cloud-platform"
759 ]
760 },
761 "delete": {
762 "description": "Ends a session, rele asing server resources associated with it.",
763 "httpMethod": "DELETE",
764 "id": "spanner.projects.instances.da tabases.sessions.delete",
765 "parameterOrder": [
766 "name"
767 ],
768 "parameters": {
769 "name": {
770 "description": "Required. Th e name of the session to delete.",
771 "location": "path",
772 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
773 "required": true,
774 "type": "string"
775 }
776 },
777 "path": "v1/{+name}",
778 "response": {
779 "$ref": "Empty"
780 },
781 "scopes": [
782 "https://www.googleapis.com/auth /cloud-platform"
783 ]
784 },
785 "beginTransaction": {
786 "description": "Begins a new transac tion. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",
787 "httpMethod": "POST",
788 "id": "spanner.projects.instances.da tabases.sessions.beginTransaction",
789 "parameterOrder": [
790 "session"
791 ],
792 "parameters": {
793 "session": {
794 "description": "Required. Th e session in which the transaction runs.",
795 "location": "path",
796 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
797 "required": true,
798 "type": "string"
799 }
800 },
801 "path": "v1/{+session}:beginTransact ion",
802 "request": {
803 "$ref": "BeginTransactionRequest "
804 },
805 "response": {
806 "$ref": "Transaction"
807 },
808 "scopes": [
809 "https://www.googleapis.com/auth /cloud-platform"
927 ] 810 ]
928 }, 811 },
929 "commit": { 812 "commit": {
930 "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. ", 813 "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. ",
931 "httpMethod": "POST", 814 "httpMethod": "POST",
932 "id": "spanner.projects.instances.da tabases.sessions.commit", 815 "id": "spanner.projects.instances.da tabases.sessions.commit",
933 "parameterOrder": [ 816 "parameterOrder": [
934 "session" 817 "session"
935 ], 818 ],
936 "parameters": { 819 "parameters": {
937 "session": { 820 "session": {
938 "description": "Required. Th e session in which the transaction to be committed is running.", 821 "description": "Required. Th e session in which the transaction to be committed is running.",
939 "location": "path", 822 "location": "path",
940 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$", 823 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
941 "required": true, 824 "required": true,
942 "type": "string" 825 "type": "string"
943 } 826 }
944 }, 827 },
945 "path": "v1/{+session}:commit", 828 "path": "v1/{+session}:commit",
946 "request": { 829 "request": {
947 "$ref": "CommitRequest" 830 "$ref": "CommitRequest"
948 }, 831 },
949 "response": { 832 "response": {
950 "$ref": "CommitResponse" 833 "$ref": "CommitResponse"
951 }, 834 },
952 "scopes": [ 835 "scopes": [
953 "https://www.googleapis.com/auth /cloud-platform" 836 "https://www.googleapis.com/auth /cloud-platform"
954 ] 837 ]
955 }, 838 },
956 "beginTransaction": { 839 "executeSql": {
957 "description": "Begins a new transac tion. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.", 840 "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.",
958 "httpMethod": "POST", 841 "httpMethod": "POST",
959 "id": "spanner.projects.instances.da tabases.sessions.beginTransaction", 842 "id": "spanner.projects.instances.da tabases.sessions.executeSql",
960 "parameterOrder": [
961 "session"
962 ],
963 "parameters": {
964 "session": {
965 "description": "Required. Th e session in which the transaction runs.",
966 "location": "path",
967 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
968 "required": true,
969 "type": "string"
970 }
971 },
972 "path": "v1/{+session}:beginTransact ion",
973 "request": {
974 "$ref": "BeginTransactionRequest "
975 },
976 "response": {
977 "$ref": "Transaction"
978 },
979 "scopes": [
980 "https://www.googleapis.com/auth /cloud-platform"
981 ]
982 },
983 "executeStreamingSql": {
984 "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.",
985 "httpMethod": "POST",
986 "id": "spanner.projects.instances.da tabases.sessions.executeStreamingSql",
987 "parameterOrder": [ 843 "parameterOrder": [
988 "session" 844 "session"
989 ], 845 ],
990 "parameters": { 846 "parameters": {
991 "session": { 847 "session": {
992 "description": "Required. Th e session in which the SQL query should be performed.", 848 "description": "Required. Th e session in which the SQL query should be performed.",
993 "location": "path", 849 "location": "path",
994 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$", 850 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
995 "required": true, 851 "required": true,
996 "type": "string" 852 "type": "string"
997 } 853 }
998 }, 854 },
999 "path": "v1/{+session}:executeStream ingSql", 855 "path": "v1/{+session}:executeSql",
1000 "request": { 856 "request": {
1001 "$ref": "ExecuteSqlRequest" 857 "$ref": "ExecuteSqlRequest"
1002 }, 858 },
1003 "response": { 859 "response": {
860 "$ref": "ResultSet"
861 },
862 "scopes": [
863 "https://www.googleapis.com/auth /cloud-platform"
864 ]
865 },
866 "rollback": {
867 "description": "Rolls back a transac tion, releasing any locks it holds. It is a good\nidea to call this for any tran saction that includes one or more\nRead or ExecuteSql requests and\nultimately d ecides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the t ransaction, the\ntransaction was already aborted, or the transaction is not\nfou nd. `Rollback` never returns `ABORTED`.",
868 "httpMethod": "POST",
869 "id": "spanner.projects.instances.da tabases.sessions.rollback",
870 "parameterOrder": [
871 "session"
872 ],
873 "parameters": {
874 "session": {
875 "description": "Required. Th e session in which the transaction to roll back is running.",
876 "location": "path",
877 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
878 "required": true,
879 "type": "string"
880 }
881 },
882 "path": "v1/{+session}:rollback",
883 "request": {
884 "$ref": "RollbackRequest"
885 },
886 "response": {
887 "$ref": "Empty"
888 },
889 "scopes": [
890 "https://www.googleapis.com/auth /cloud-platform"
891 ]
892 },
893 "streamingRead": {
894 "description": "Like Read, except re turns the result set as a\nstream. Unlike Read, there is no limit on the\nsize o f the returned result set. However, no individual row in\nthe result set can exc eed 100 MiB, and no column value can exceed\n10 MiB.",
895 "httpMethod": "POST",
896 "id": "spanner.projects.instances.da tabases.sessions.streamingRead",
897 "parameterOrder": [
898 "session"
899 ],
900 "parameters": {
901 "session": {
902 "description": "Required. Th e session in which the read should be performed.",
903 "location": "path",
904 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
905 "required": true,
906 "type": "string"
907 }
908 },
909 "path": "v1/{+session}:streamingRead ",
910 "request": {
911 "$ref": "ReadRequest"
912 },
913 "response": {
1004 "$ref": "PartialResultSet" 914 "$ref": "PartialResultSet"
1005 }, 915 },
1006 "scopes": [ 916 "scopes": [
1007 "https://www.googleapis.com/auth /cloud-platform" 917 "https://www.googleapis.com/auth /cloud-platform"
1008 ] 918 ]
1009 }, 919 },
1010 "delete": { 920 "create": {
1011 "description": "Ends a session, rele asing server resources associated with it.", 921 "description": "Creates a new sessio n. A session can be used to perform\ntransactions that read and/or modify data i n a Cloud Spanner database.\nSessions are meant to be reused for many consecutiv e\ntransactions.\n\nSessions can only execute one transaction at a time. To exec ute\nmultiple concurrent read-write/write-only transactions, create\nmultiple se ssions. Note that standalone reads and queries use a\ntransaction internally, an d count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete i dle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can de lete sessions for which no\noperations are sent for more than an hour. If a sess ion is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
1012 "httpMethod": "DELETE", 922 "httpMethod": "POST",
1013 "id": "spanner.projects.instances.da tabases.sessions.delete", 923 "id": "spanner.projects.instances.da tabases.sessions.create",
1014 "parameterOrder": [ 924 "parameterOrder": [
1015 "name" 925 "database"
1016 ], 926 ],
1017 "parameters": { 927 "parameters": {
1018 "name": { 928 "database": {
1019 "description": "Required. Th e name of the session to delete.", 929 "description": "Required. Th e database in which the new session is created.",
930 "location": "path",
931 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+$",
932 "required": true,
933 "type": "string"
934 }
935 },
936 "path": "v1/{+database}/sessions",
937 "response": {
938 "$ref": "Session"
939 },
940 "scopes": [
941 "https://www.googleapis.com/auth /cloud-platform"
942 ]
943 },
944 "read": {
945 "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative t o\nExecuteSql. This method cannot be used to\nreturn a result set larger than 1 0 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_P RECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORT ED`. If\nthis occurs, the application should restart the transaction from\nthe b eginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.",
946 "httpMethod": "POST",
947 "id": "spanner.projects.instances.da tabases.sessions.read",
948 "parameterOrder": [
949 "session"
950 ],
951 "parameters": {
952 "session": {
953 "description": "Required. Th e session in which the read should be performed.",
1020 "location": "path", 954 "location": "path",
1021 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$", 955 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
1022 "required": true, 956 "required": true,
1023 "type": "string" 957 "type": "string"
1024 } 958 }
1025 }, 959 },
1026 "path": "v1/{+name}", 960 "path": "v1/{+session}:read",
961 "request": {
962 "$ref": "ReadRequest"
963 },
1027 "response": { 964 "response": {
1028 "$ref": "Empty" 965 "$ref": "ResultSet"
1029 }, 966 },
1030 "scopes": [ 967 "scopes": [
1031 "https://www.googleapis.com/auth /cloud-platform" 968 "https://www.googleapis.com/auth /cloud-platform"
1032 ] 969 ]
1033 } 970 }
1034 } 971 }
1035 } 972 }
1036 } 973 }
1037 }, 974 },
1038 "operations": { 975 "operations": {
1039 "methods": { 976 "methods": {
1040 "cancel": { 977 "list": {
1041 "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`.", 978 "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 below allows API servic es to override the binding\nto use different resource name schemes, such as `use rs/*/operations`.",
1042 "httpMethod": "POST", 979 "httpMethod": "GET",
1043 "id": "spanner.projects.instances.operations .cancel", 980 "id": "spanner.projects.instances.operations .list",
981 "parameterOrder": [
982 "name"
983 ],
984 "parameters": {
985 "filter": {
986 "description": "The standard list fi lter.",
987 "location": "query",
988 "type": "string"
989 },
990 "name": {
991 "description": "The name of the oper ation collection.",
992 "location": "path",
993 "pattern": "^projects/[^/]+/instance s/[^/]+/operations$",
994 "required": true,
995 "type": "string"
996 },
997 "pageToken": {
998 "description": "The standard list pa ge token.",
999 "location": "query",
1000 "type": "string"
1001 },
1002 "pageSize": {
1003 "description": "The standard list pa ge size.",
1004 "format": "int32",
1005 "location": "query",
1006 "type": "integer"
1007 }
1008 },
1009 "path": "v1/{+name}",
1010 "response": {
1011 "$ref": "ListOperationsResponse"
1012 },
1013 "scopes": [
1014 "https://www.googleapis.com/auth/cloud-p latform"
1015 ]
1016 },
1017 "get": {
1018 "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.",
1019 "httpMethod": "GET",
1020 "id": "spanner.projects.instances.operations .get",
1044 "parameterOrder": [ 1021 "parameterOrder": [
1045 "name" 1022 "name"
1046 ], 1023 ],
1047 "parameters": { 1024 "parameters": {
1048 "name": { 1025 "name": {
1049 "description": "The name of the oper ation resource to be cancelled.", 1026 "description": "The name of the oper ation resource.",
1050 "location": "path", 1027 "location": "path",
1051 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$", 1028 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
1052 "required": true, 1029 "required": true,
1053 "type": "string"
1054 }
1055 },
1056 "path": "v1/{+name}:cancel",
1057 "response": {
1058 "$ref": "Empty"
1059 },
1060 "scopes": [
1061 "https://www.googleapis.com/auth/cloud-p latform"
1062 ]
1063 },
1064 "delete": {
1065 "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`.",
1066 "httpMethod": "DELETE",
1067 "id": "spanner.projects.instances.operations .delete",
1068 "parameterOrder": [
1069 "name"
1070 ],
1071 "parameters": {
1072 "name": {
1073 "description": "The name of the oper ation resource to be deleted.",
1074 "location": "path",
1075 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
1076 "required": true,
1077 "type": "string" 1030 "type": "string"
1078 } 1031 }
1079 }, 1032 },
1080 "path": "v1/{+name}", 1033 "path": "v1/{+name}",
1081 "response": { 1034 "response": {
1035 "$ref": "Operation"
1036 },
1037 "scopes": [
1038 "https://www.googleapis.com/auth/cloud-p latform"
1039 ]
1040 },
1041 "cancel": {
1042 "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`.",
1043 "httpMethod": "POST",
1044 "id": "spanner.projects.instances.operations .cancel",
1045 "parameterOrder": [
1046 "name"
1047 ],
1048 "parameters": {
1049 "name": {
1050 "description": "The name of the oper ation resource to be cancelled.",
1051 "location": "path",
1052 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
1053 "required": true,
1054 "type": "string"
1055 }
1056 },
1057 "path": "v1/{+name}:cancel",
1058 "response": {
1082 "$ref": "Empty" 1059 "$ref": "Empty"
1083 }, 1060 },
1084 "scopes": [ 1061 "scopes": [
1085 "https://www.googleapis.com/auth/cloud-p latform" 1062 "https://www.googleapis.com/auth/cloud-p latform"
1086 ] 1063 ]
1087 }, 1064 },
1088 "list": { 1065 "delete": {
1089 "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 below allows API servic es to override the binding\nto use different resource name schemes, such as `use rs/*/operations`.", 1066 "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`.",
1090 "httpMethod": "GET", 1067 "httpMethod": "DELETE",
1091 "id": "spanner.projects.instances.operations .list", 1068 "id": "spanner.projects.instances.operations .delete",
1092 "parameterOrder": [ 1069 "parameterOrder": [
1093 "name" 1070 "name"
1094 ], 1071 ],
1095 "parameters": { 1072 "parameters": {
1096 "name": { 1073 "name": {
1097 "description": "The name of the oper ation collection.", 1074 "description": "The name of the oper ation resource to be deleted.",
1098 "location": "path",
1099 "pattern": "^projects/[^/]+/instance s/[^/]+/operations$",
1100 "required": true,
1101 "type": "string"
1102 },
1103 "pageToken": {
1104 "description": "The standard list pa ge token.",
1105 "location": "query",
1106 "type": "string"
1107 },
1108 "pageSize": {
1109 "description": "The standard list pa ge size.",
1110 "format": "int32",
1111 "location": "query",
1112 "type": "integer"
1113 },
1114 "filter": {
1115 "description": "The standard list fi lter.",
1116 "location": "query",
1117 "type": "string"
1118 }
1119 },
1120 "path": "v1/{+name}",
1121 "response": {
1122 "$ref": "ListOperationsResponse"
1123 },
1124 "scopes": [
1125 "https://www.googleapis.com/auth/cloud-p latform"
1126 ]
1127 },
1128 "get": {
1129 "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.",
1130 "httpMethod": "GET",
1131 "id": "spanner.projects.instances.operations .get",
1132 "parameterOrder": [
1133 "name"
1134 ],
1135 "parameters": {
1136 "name": {
1137 "description": "The name of the oper ation resource.",
1138 "location": "path", 1075 "location": "path",
1139 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$", 1076 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
1140 "required": true, 1077 "required": true,
1141 "type": "string" 1078 "type": "string"
1142 } 1079 }
1143 }, 1080 },
1144 "path": "v1/{+name}", 1081 "path": "v1/{+name}",
1145 "response": { 1082 "response": {
1146 "$ref": "Operation" 1083 "$ref": "Empty"
1147 }, 1084 },
1148 "scopes": [ 1085 "scopes": [
1149 "https://www.googleapis.com/auth/cloud-p latform" 1086 "https://www.googleapis.com/auth/cloud-p latform"
1150 ] 1087 ]
1151 } 1088 }
1152 } 1089 }
1153 } 1090 }
1154 } 1091 }
1092 },
1093 "instanceConfigs": {
1094 "methods": {
1095 "list": {
1096 "description": "Lists the supported instance configu rations for a given project.",
1097 "httpMethod": "GET",
1098 "id": "spanner.projects.instanceConfigs.list",
1099 "parameterOrder": [
1100 "parent"
1101 ],
1102 "parameters": {
1103 "pageSize": {
1104 "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.",
1105 "format": "int32",
1106 "location": "query",
1107 "type": "integer"
1108 },
1109 "parent": {
1110 "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>`.",
1111 "location": "path",
1112 "pattern": "^projects/[^/]+$",
1113 "required": true,
1114 "type": "string"
1115 },
1116 "pageToken": {
1117 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
1118 "location": "query",
1119 "type": "string"
1120 }
1121 },
1122 "path": "v1/{+parent}/instanceConfigs",
1123 "response": {
1124 "$ref": "ListInstanceConfigsResponse"
1125 },
1126 "scopes": [
1127 "https://www.googleapis.com/auth/cloud-platform"
1128 ]
1129 },
1130 "get": {
1131 "description": "Gets information about a particular instance configuration.",
1132 "httpMethod": "GET",
1133 "id": "spanner.projects.instanceConfigs.get",
1134 "parameterOrder": [
1135 "name"
1136 ],
1137 "parameters": {
1138 "name": {
1139 "description": "Required. The name of the re quested instance configuration. Values are of\nthe form `projects/<project>/inst anceConfigs/<config>`.",
1140 "location": "path",
1141 "pattern": "^projects/[^/]+/instanceConfigs/ [^/]+$",
1142 "required": true,
1143 "type": "string"
1144 }
1145 },
1146 "path": "v1/{+name}",
1147 "response": {
1148 "$ref": "InstanceConfig"
1149 },
1150 "scopes": [
1151 "https://www.googleapis.com/auth/cloud-platform"
1152 ]
1153 }
1154 }
1155 } 1155 }
1156 } 1156 }
1157 } 1157 }
1158 }, 1158 },
1159 "revision": "20170214", 1159 "revision": "20170317",
1160 "rootUrl": "https://spanner.googleapis.com/", 1160 "rootUrl": "https://spanner.googleapis.com/",
1161 "schemas": { 1161 "schemas": {
1162 "ResultSetStats": {
1163 "description": "Additional statistics about a ResultSet or PartialRe sultSet.",
1164 "id": "ResultSetStats",
1165 "properties": {
1166 "queryStats": {
1167 "additionalProperties": {
1168 "description": "Properties of the object.",
1169 "type": "any"
1170 },
1171 "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
1172 "type": "object"
1173 },
1174 "queryPlan": {
1175 "$ref": "QueryPlan",
1176 "description": "QueryPlan for the query associated with this result."
1177 }
1178 },
1179 "type": "object"
1180 },
1181 "TestIamPermissionsRequest": {
1182 "description": "Request message for `TestIamPermissions` method.",
1183 "id": "TestIamPermissionsRequest",
1184 "properties": {
1185 "permissions": {
1186 "description": "REQUIRED: The set of permissions to check fo r 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.in stances.*') are not allowed.",
1187 "items": {
1188 "type": "string"
1189 },
1190 "type": "array"
1191 }
1192 },
1193 "type": "object"
1194 },
1195 "CommitResponse": {
1196 "description": "The response for Commit.",
1197 "id": "CommitResponse",
1198 "properties": {
1199 "commitTimestamp": {
1200 "description": "The Cloud Spanner timestamp at which the tra nsaction committed.",
1201 "format": "google-datetime",
1202 "type": "string"
1203 }
1204 },
1205 "type": "object"
1206 },
1207 "Type": {
1208 "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
1209 "id": "Type",
1210 "properties": {
1211 "arrayElementType": {
1212 "$ref": "Type",
1213 "description": "If code == ARRAY, then `array_element_type`\ nis the type of the array elements."
1214 },
1215 "code": {
1216 "description": "Required. The TypeCode for this type.",
1217 "enum": [
1218 "TYPE_CODE_UNSPECIFIED",
1219 "BOOL",
1220 "INT64",
1221 "FLOAT64",
1222 "TIMESTAMP",
1223 "DATE",
1224 "STRING",
1225 "BYTES",
1226 "ARRAY",
1227 "STRUCT"
1228 ],
1229 "enumDescriptions": [
1230 "Not specified.",
1231 "Encoded as JSON `true` or `false`.",
1232 "Encoded as `string`, in decimal format.",
1233 "Encoded as `number`, or the strings `\"NaN\"`, `\"Infin ity\"`, or\n`\"-Infinity\"`.",
1234 "Encoded as `string` in RFC 3339 timestamp format. The t ime zone\nmust be present, and must be `\"Z\"`.",
1235 "Encoded as `string` in RFC 3339 date format.",
1236 "Encoded as `string`.",
1237 "Encoded as a base64-encoded `string`, as described in R FC 4648,\nsection 4.",
1238 "Encoded as `list`, where the list elements are represen ted\naccording to array_element_type.",
1239 "Encoded as `list`, where list element `i` is represente d according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
1240 ],
1241 "type": "string"
1242 },
1243 "structType": {
1244 "$ref": "StructType",
1245 "description": "If code == STRUCT, then `struct_type`\nprovi des type information for the struct's fields."
1246 }
1247 },
1248 "type": "object"
1249 },
1250 "PlanNode": {
1251 "description": "Node information for nodes appearing in a QueryPlan. plan_nodes.",
1252 "id": "PlanNode",
1253 "properties": {
1254 "metadata": {
1255 "additionalProperties": {
1256 "description": "Properties of the object.",
1257 "type": "any"
1258 },
1259 "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 }",
1260 "type": "object"
1261 },
1262 "executionStats": {
1263 "additionalProperties": {
1264 "description": "Properties of the object.",
1265 "type": "any"
1266 },
1267 "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.",
1268 "type": "object"
1269 },
1270 "shortRepresentation": {
1271 "$ref": "ShortRepresentation",
1272 "description": "Condensed representation for SCALAR nodes."
1273 },
1274 "index": {
1275 "description": "The `PlanNode`'s index in node list.",
1276 "format": "int32",
1277 "type": "integer"
1278 },
1279 "kind": {
1280 "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.",
1281 "enum": [
1282 "KIND_UNSPECIFIED",
1283 "RELATIONAL",
1284 "SCALAR"
1285 ],
1286 "enumDescriptions": [
1287 "Not specified.",
1288 "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.",
1289 "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."
1290 ],
1291 "type": "string"
1292 },
1293 "displayName": {
1294 "description": "The display name for the node.",
1295 "type": "string"
1296 },
1297 "childLinks": {
1298 "description": "List of child node `index`es and their relat ionship to this parent.",
1299 "items": {
1300 "$ref": "ChildLink"
1301 },
1302 "type": "array"
1303 }
1304 },
1305 "type": "object"
1306 },
1307 "AuditConfig": {
1308 "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, ar e exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs." ,
1309 "id": "AuditConfig",
1310 "properties": {
1311 "exemptedMembers": {
1312 "description": "Specifies the identities that are exempted f rom \"data access\" audit\nlogging for the `service` specified above.\nFollows t he same format of Binding.members.\nThis field is deprecated in favor of per-per mission-type exemptions.",
1313 "items": {
1314 "type": "string"
1315 },
1316 "type": "array"
1317 },
1318 "service": {
1319 "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServ ices` is a special value that covers all services.",
1320 "type": "string"
1321 },
1322 "auditLogConfigs": {
1323 "description": "The configuration for logging of each type o f permission.\nNext ID: 4",
1324 "items": {
1325 "$ref": "AuditLogConfig"
1326 },
1327 "type": "array"
1328 }
1329 },
1330 "type": "object"
1331 },
1332 "CreateInstanceMetadata": {
1333 "description": "Metadata type for the operation returned by\nCreateI nstance.",
1334 "id": "CreateInstanceMetadata",
1335 "properties": {
1336 "instance": {
1337 "$ref": "Instance",
1338 "description": "The instance being created."
1339 },
1340 "startTime": {
1341 "description": "The time at which the\nCreateInstance reques t was\nreceived.",
1342 "format": "google-datetime",
1343 "type": "string"
1344 },
1345 "cancelTime": {
1346 "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.",
1347 "format": "google-datetime",
1348 "type": "string"
1349 },
1350 "endTime": {
1351 "description": "The time at which this operation failed or w as completed successfully.",
1352 "format": "google-datetime",
1353 "type": "string"
1354 }
1355 },
1356 "type": "object"
1357 },
1358 "ChildLink": {
1359 "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
1360 "id": "ChildLink",
1361 "properties": {
1362 "childIndex": {
1363 "description": "The node to which the link points.",
1364 "format": "int32",
1365 "type": "integer"
1366 },
1367 "variable": {
1368 "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.",
1369 "type": "string"
1370 },
1371 "type": {
1372 "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.",
1373 "type": "string"
1374 }
1375 },
1376 "type": "object"
1377 },
1378 "CloudAuditOptions": {
1379 "description": "Write a Cloud Audit log",
1380 "id": "CloudAuditOptions",
1381 "properties": {},
1382 "type": "object"
1383 },
1384 "Delete": {
1385 "description": "Arguments to delete operations.",
1386 "id": "Delete",
1387 "properties": {
1388 "table": {
1389 "description": "Required. The table whose rows will be delet ed.",
1390 "type": "string"
1391 },
1392 "keySet": {
1393 "$ref": "KeySet",
1394 "description": "Required. The primary keys of the rows withi n table to delete."
1395 }
1396 },
1397 "type": "object"
1398 },
1399 "BeginTransactionRequest": {
1400 "description": "The request for BeginTransaction.",
1401 "id": "BeginTransactionRequest",
1402 "properties": {
1403 "options": {
1404 "$ref": "TransactionOptions",
1405 "description": "Required. Options for the new transaction."
1406 }
1407 },
1408 "type": "object"
1409 },
1410 "CommitRequest": {
1411 "description": "The request for Commit.",
1412 "id": "CommitRequest",
1413 "properties": {
1414 "singleUseTransaction": {
1415 "$ref": "TransactionOptions",
1416 "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."
1417 },
1418 "mutations": {
1419 "description": "The mutations to be executed when this trans action commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
1420 "items": {
1421 "$ref": "Mutation"
1422 },
1423 "type": "array"
1424 },
1425 "transactionId": {
1426 "description": "Commit a previously-started transaction.",
1427 "format": "byte",
1428 "type": "string"
1429 }
1430 },
1431 "type": "object"
1432 },
1433 "ListInstanceConfigsResponse": {
1434 "description": "The response for ListInstanceConfigs.",
1435 "id": "ListInstanceConfigsResponse",
1436 "properties": {
1437 "nextPageToken": {
1438 "description": "`next_page_token` can be sent in a subsequen t\nListInstanceConfigs call to\nfetch more of the matching instance configuratio ns.",
1439 "type": "string"
1440 },
1441 "instanceConfigs": {
1442 "description": "The list of requested instance configuration s.",
1443 "items": {
1444 "$ref": "InstanceConfig"
1445 },
1446 "type": "array"
1447 }
1448 },
1449 "type": "object"
1450 },
1451 "TestIamPermissionsResponse": {
1452 "description": "Response message for `TestIamPermissions` method.",
1453 "id": "TestIamPermissionsResponse",
1454 "properties": {
1455 "permissions": {
1456 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.",
1457 "items": {
1458 "type": "string"
1459 },
1460 "type": "array"
1461 }
1462 },
1463 "type": "object"
1464 },
1465 "GetIamPolicyRequest": {
1466 "description": "Request message for `GetIamPolicy` method.",
1467 "id": "GetIamPolicyRequest",
1468 "properties": {},
1469 "type": "object"
1470 },
1471 "Rule": {
1472 "description": "A rule to be applied in a Policy.",
1473 "id": "Rule",
1474 "properties": {
1475 "in": {
1476 "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.",
1477 "items": {
1478 "type": "string"
1479 },
1480 "type": "array"
1481 },
1482 "permissions": {
1483 "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.",
1484 "items": {
1485 "type": "string"
1486 },
1487 "type": "array"
1488 },
1489 "action": {
1490 "description": "Required",
1491 "enum": [
1492 "NO_ACTION",
1493 "ALLOW",
1494 "ALLOW_WITH_LOG",
1495 "DENY",
1496 "DENY_WITH_LOG",
1497 "LOG"
1498 ],
1499 "enumDescriptions": [
1500 "Default no action.",
1501 "Matching 'Entries' grant access.",
1502 "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
1503 "Matching 'Entries' deny access.",
1504 "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
1505 "Matching 'Entries' tell IAM.Check callers to generate l ogs."
1506 ],
1507 "type": "string"
1508 },
1509 "notIn": {
1510 "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).",
1511 "items": {
1512 "type": "string"
1513 },
1514 "type": "array"
1515 },
1516 "description": {
1517 "description": "Human-readable description of the rule.",
1518 "type": "string"
1519 },
1520 "conditions": {
1521 "description": "Additional restrictions that must be met",
1522 "items": {
1523 "$ref": "Condition"
1524 },
1525 "type": "array"
1526 },
1527 "logConfig": {
1528 "description": "The config returned to callers of tech.iam.I AM.CheckPolicy for any entries\nthat match the LOG action.",
1529 "items": {
1530 "$ref": "LogConfig"
1531 },
1532 "type": "array"
1533 }
1534 },
1535 "type": "object"
1536 },
1537 "CreateDatabaseMetadata": {
1538 "description": "Metadata type for the operation returned by\nCreateD atabase.",
1539 "id": "CreateDatabaseMetadata",
1540 "properties": {
1541 "database": {
1542 "description": "The database being created.",
1543 "type": "string"
1544 }
1545 },
1546 "type": "object"
1547 },
1548 "LogConfig": {
1549 "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",
1550 "id": "LogConfig",
1551 "properties": {
1552 "dataAccess": {
1553 "$ref": "DataAccessOptions",
1554 "description": "Data access options."
1555 },
1556 "cloudAudit": {
1557 "$ref": "CloudAuditOptions",
1558 "description": "Cloud audit options."
1559 },
1560 "counter": {
1561 "$ref": "CounterOptions",
1562 "description": "Counter options."
1563 }
1564 },
1565 "type": "object"
1566 },
1567 "Session": { 1162 "Session": {
1568 "description": "A session in the Cloud Spanner API.", 1163 "description": "A session in the Cloud Spanner API.",
1569 "id": "Session", 1164 "id": "Session",
1570 "properties": { 1165 "properties": {
1571 "name": { 1166 "name": {
1572 "description": "Required. The name of the session.", 1167 "description": "Required. The name of the session.",
1573 "type": "string" 1168 "type": "string"
1574 } 1169 }
1575 }, 1170 },
1576 "type": "object" 1171 "type": "object"
1577 }, 1172 },
1173 "ListInstancesResponse": {
1174 "description": "The response for ListInstances.",
1175 "id": "ListInstancesResponse",
1176 "properties": {
1177 "nextPageToken": {
1178 "description": "`next_page_token` can be sent in a subsequen t\nListInstances call to fetch more\nof the matching instances.",
1179 "type": "string"
1180 },
1181 "instances": {
1182 "description": "The list of requested instances.",
1183 "items": {
1184 "$ref": "Instance"
1185 },
1186 "type": "array"
1187 }
1188 },
1189 "type": "object"
1190 },
1578 "KeyRange": { 1191 "KeyRange": {
1579 "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.", 1192 "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.",
1580 "id": "KeyRange", 1193 "id": "KeyRange",
1581 "properties": { 1194 "properties": {
1195 "endOpen": {
1196 "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
1197 "items": {
1198 "type": "any"
1199 },
1200 "type": "array"
1201 },
1202 "endClosed": {
1203 "description": "If the end is closed, then the range include s all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed` .",
1204 "items": {
1205 "type": "any"
1206 },
1207 "type": "array"
1208 },
1582 "startClosed": { 1209 "startClosed": {
1583 "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`.", 1210 "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`.",
1584 "items": { 1211 "items": {
1585 "type": "any" 1212 "type": "any"
1586 }, 1213 },
1587 "type": "array" 1214 "type": "array"
1588 }, 1215 },
1589 "startOpen": { 1216 "startOpen": {
1590 "description": "If the start is open, then the range exclude s rows whose first\n`len(start_open)` key columns exactly match `start_open`.", 1217 "description": "If the start is open, then the range exclude s rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
1591 "items": { 1218 "items": {
1592 "type": "any" 1219 "type": "any"
1593 }, 1220 },
1594 "type": "array" 1221 "type": "array"
1595 },
1596 "endOpen": {
1597 "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
1598 "items": {
1599 "type": "any"
1600 },
1601 "type": "array"
1602 },
1603 "endClosed": {
1604 "description": "If the end is closed, then the range include s all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed` .",
1605 "items": {
1606 "type": "any"
1607 },
1608 "type": "array"
1609 }
1610 },
1611 "type": "object"
1612 },
1613 "ListInstancesResponse": {
1614 "description": "The response for ListInstances.",
1615 "id": "ListInstancesResponse",
1616 "properties": {
1617 "nextPageToken": {
1618 "description": "`next_page_token` can be sent in a subsequen t\nListInstances call to fetch more\nof the matching instances.",
1619 "type": "string"
1620 },
1621 "instances": {
1622 "description": "The list of requested instances.",
1623 "items": {
1624 "$ref": "Instance"
1625 },
1626 "type": "array"
1627 } 1222 }
1628 }, 1223 },
1629 "type": "object" 1224 "type": "object"
1630 }, 1225 },
1631 "ShortRepresentation": { 1226 "ShortRepresentation": {
1632 "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).", 1227 "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
1633 "id": "ShortRepresentation", 1228 "id": "ShortRepresentation",
1634 "properties": { 1229 "properties": {
1635 "description": { 1230 "description": {
1636 "description": "A string representation of the expression su btree rooted at this node.", 1231 "description": "A string representation of the expression su btree rooted at this node.",
1637 "type": "string" 1232 "type": "string"
1638 }, 1233 },
1639 "subqueries": { 1234 "subqueries": {
1640 "additionalProperties": { 1235 "additionalProperties": {
1641 "format": "int32", 1236 "format": "int32",
1642 "type": "integer" 1237 "type": "integer"
1643 }, 1238 },
1644 "description": "A mapping of (subquery variable name) -> (su bquery node id) for cases\nwhere the `description` string of this node reference s a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.", 1239 "description": "A mapping of (subquery variable name) -> (su bquery node id) for cases\nwhere the `description` string of this node reference s a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
1645 "type": "object" 1240 "type": "object"
1646 } 1241 }
1647 }, 1242 },
1648 "type": "object" 1243 "type": "object"
1649 }, 1244 },
1650 "InstanceConfig": { 1245 "InstanceConfig": {
1651 "description": "A possible configuration for a Cloud Spanner instanc e. Configurations\ndefine the geographic placement of nodes and their replicatio n.", 1246 "description": "A possible configuration for a Cloud Spanner instanc e. Configurations\ndefine the geographic placement of nodes and their replicatio n.",
1652 "id": "InstanceConfig", 1247 "id": "InstanceConfig",
1653 "properties": { 1248 "properties": {
1249 "displayName": {
1250 "description": "The name of this instance configuration as i t appears in UIs.",
1251 "type": "string"
1252 },
1654 "name": { 1253 "name": {
1655 "description": "A unique identifier for the instance configu ration. Values\nare of the form\n`projects/<project>/instanceConfigs/a-z*`", 1254 "description": "A unique identifier for the instance configu ration. Values\nare of the form\n`projects/<project>/instanceConfigs/a-z*`",
1656 "type": "string" 1255 "type": "string"
1657 },
1658 "displayName": {
1659 "description": "The name of this instance configuration as i t appears in UIs.",
1660 "type": "string"
1661 } 1256 }
1662 }, 1257 },
1663 "type": "object" 1258 "type": "object"
1664 }, 1259 },
1665 "UpdateInstanceRequest": { 1260 "UpdateInstanceRequest": {
1666 "description": "The request for UpdateInstance.", 1261 "description": "The request for UpdateInstance.",
1667 "id": "UpdateInstanceRequest", 1262 "id": "UpdateInstanceRequest",
1668 "properties": { 1263 "properties": {
1669 "instance": { 1264 "instance": {
1670 "$ref": "Instance", 1265 "$ref": "Instance",
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after
1751 ], 1346 ],
1752 "enumDescriptions": [ 1347 "enumDescriptions": [
1753 "Default non-attribute type", 1348 "Default non-attribute type",
1754 "Region of the resource", 1349 "Region of the resource",
1755 "Service name", 1350 "Service name",
1756 "Resource name", 1351 "Resource name",
1757 "IP address of the caller" 1352 "IP address of the caller"
1758 ], 1353 ],
1759 "type": "string" 1354 "type": "string"
1760 }, 1355 },
1356 "iam": {
1357 "description": "Trusted attributes supplied by the IAM syste m.",
1358 "enum": [
1359 "NO_ATTR",
1360 "AUTHORITY",
1361 "ATTRIBUTION",
1362 "SECURITY_REALM",
1363 "APPROVER"
1364 ],
1365 "enumDescriptions": [
1366 "Default non-attribute.",
1367 "Either principal or (if present) authority selector.",
1368 "The principal (even if an authority selector is present ), which\nmust only be used for attribution, not authorization.",
1369 "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).",
1370 "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).\nSee: go/rpc-security-policy-dynamicauth."
1371 ],
1372 "type": "string"
1373 },
1761 "values": { 1374 "values": {
1762 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.", 1375 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.",
1763 "items": { 1376 "items": {
1764 "type": "string" 1377 "type": "string"
1765 }, 1378 },
1766 "type": "array" 1379 "type": "array"
1767 }, 1380 },
1768 "iam": {
1769 "description": "Trusted attributes supplied by the IAM syste m.",
1770 "enum": [
1771 "NO_ATTR",
1772 "AUTHORITY",
1773 "ATTRIBUTION",
1774 "SECURITY_REALM"
1775 ],
1776 "enumDescriptions": [
1777 "Default non-attribute.",
1778 "Either principal or (if present) authority selector.",
1779 "The principal (even if an authority selector is present ), which\nmust only be used for attribution, not authorization.",
1780 "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)."
1781 ],
1782 "type": "string"
1783 },
1784 "op": { 1381 "op": {
1785 "description": "An operator to apply the subject with.", 1382 "description": "An operator to apply the subject with.",
1786 "enum": [ 1383 "enum": [
1787 "NO_OP", 1384 "NO_OP",
1788 "EQUALS", 1385 "EQUALS",
1789 "NOT_EQUALS", 1386 "NOT_EQUALS",
1790 "IN", 1387 "IN",
1791 "NOT_IN", 1388 "NOT_IN",
1792 "DISCHARGED" 1389 "DISCHARGED"
1793 ], 1390 ],
(...skipping 41 matching lines...) Expand 10 before | Expand all | Expand 10 after
1835 ], 1432 ],
1836 "type": "string" 1433 "type": "string"
1837 } 1434 }
1838 }, 1435 },
1839 "type": "object" 1436 "type": "object"
1840 }, 1437 },
1841 "ReadOnly": { 1438 "ReadOnly": {
1842 "description": "Options for read-only transactions.", 1439 "description": "Options for read-only transactions.",
1843 "id": "ReadOnly", 1440 "id": "ReadOnly",
1844 "properties": { 1441 "properties": {
1845 "readTimestamp": { 1442 "strong": {
1846 "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.", 1443 "description": "Read at a timestamp where all previously com mitted transactions\nare visible.",
1444 "type": "boolean"
1445 },
1446 "minReadTimestamp": {
1447 "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.",
1847 "format": "google-datetime", 1448 "format": "google-datetime",
1848 "type": "string" 1449 "type": "string"
1849 }, 1450 },
1850 "maxStaleness": { 1451 "maxStaleness": {
1851 "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.", 1452 "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.",
1852 "format": "google-duration", 1453 "format": "google-duration",
1853 "type": "string" 1454 "type": "string"
1854 }, 1455 },
1456 "readTimestamp": {
1457 "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.",
1458 "format": "google-datetime",
1459 "type": "string"
1460 },
1855 "returnReadTimestamp": { 1461 "returnReadTimestamp": {
1856 "description": "If true, the Cloud Spanner-selected read tim estamp is included in\nthe Transaction message that describes the transaction.", 1462 "description": "If true, the Cloud Spanner-selected read tim estamp is included in\nthe Transaction message that describes the transaction.",
1857 "type": "boolean" 1463 "type": "boolean"
1858 }, 1464 },
1859 "exactStaleness": { 1465 "exactStaleness": {
1860 "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`.", 1466 "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`.",
1861 "format": "google-duration", 1467 "format": "google-duration",
1862 "type": "string" 1468 "type": "string"
1863 },
1864 "strong": {
1865 "description": "Read at a timestamp where all previously com mitted transactions\nare visible.",
1866 "type": "boolean"
1867 },
1868 "minReadTimestamp": {
1869 "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.",
1870 "format": "google-datetime",
1871 "type": "string"
1872 } 1469 }
1873 }, 1470 },
1874 "type": "object" 1471 "type": "object"
1875 }, 1472 },
1876 "ExecuteSqlRequest": { 1473 "ExecuteSqlRequest": {
1877 "description": "The request for ExecuteSql and\nExecuteStreamingSql. ", 1474 "description": "The request for ExecuteSql and\nExecuteStreamingSql. ",
1878 "id": "ExecuteSqlRequest", 1475 "id": "ExecuteSqlRequest",
1879 "properties": { 1476 "properties": {
1880 "queryMode": {
1881 "description": "Used to control the amount of debugging info rmation returned in\nResultSetStats.",
1882 "enum": [
1883 "NORMAL",
1884 "PLAN",
1885 "PROFILE"
1886 ],
1887 "enumDescriptions": [
1888 "The default mode where only the query result, without a ny information\nabout the query plan is returned.",
1889 "This mode returns only the query plan, without any resu lt rows or\nexecution statistics information.",
1890 "This mode returns both the query plan and the execution statistics along\nwith the result rows."
1891 ],
1892 "type": "string"
1893 },
1894 "transaction": {
1895 "$ref": "TransactionSelector",
1896 "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
1897 },
1898 "resumeToken": {
1899 "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.",
1900 "format": "byte",
1901 "type": "string"
1902 },
1903 "paramTypes": { 1477 "paramTypes": {
1904 "additionalProperties": { 1478 "additionalProperties": {
1905 "$ref": "Type" 1479 "$ref": "Type"
1906 }, 1480 },
1907 "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.", 1481 "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.",
1908 "type": "object" 1482 "type": "object"
1909 }, 1483 },
1910 "sql": { 1484 "sql": {
1911 "description": "Required. The SQL query string.", 1485 "description": "Required. The SQL query string.",
1912 "type": "string" 1486 "type": "string"
1913 }, 1487 },
1914 "params": { 1488 "params": {
1915 "additionalProperties": { 1489 "additionalProperties": {
1916 "description": "Properties of the object.", 1490 "description": "Properties of the object.",
1917 "type": "any" 1491 "type": "any"
1918 }, 1492 },
1919 "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.", 1493 "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.",
1920 "type": "object" 1494 "type": "object"
1495 },
1496 "queryMode": {
1497 "description": "Used to control the amount of debugging info rmation returned in\nResultSetStats.",
1498 "enum": [
1499 "NORMAL",
1500 "PLAN",
1501 "PROFILE"
1502 ],
1503 "enumDescriptions": [
1504 "The default mode where only the query result, without a ny information\nabout the query plan is returned.",
1505 "This mode returns only the query plan, without any resu lt rows or\nexecution statistics information.",
1506 "This mode returns both the query plan and the execution statistics along\nwith the result rows."
1507 ],
1508 "type": "string"
1509 },
1510 "transaction": {
1511 "$ref": "TransactionSelector",
1512 "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
1513 },
1514 "resumeToken": {
1515 "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.",
1516 "format": "byte",
1517 "type": "string"
1921 } 1518 }
1922 }, 1519 },
1923 "type": "object" 1520 "type": "object"
1924 }, 1521 },
1925 "Policy": { 1522 "Policy": {
1926 "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).", 1523 "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).",
1927 "id": "Policy", 1524 "id": "Policy",
1928 "properties": { 1525 "properties": {
1929 "iamOwned": { 1526 "iamOwned": {
1930 "type": "boolean" 1527 "type": "boolean"
(...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after
2000 "description": "Required. The name of the table in the datab ase to be read.", 1597 "description": "Required. The name of the table in the datab ase to be read.",
2001 "type": "string" 1598 "type": "string"
2002 } 1599 }
2003 }, 1600 },
2004 "type": "object" 1601 "type": "object"
2005 }, 1602 },
2006 "Write": { 1603 "Write": {
2007 "description": "Arguments to insert, update, insert_or_update, and\n replace operations.", 1604 "description": "Arguments to insert, update, insert_or_update, and\n replace operations.",
2008 "id": "Write", 1605 "id": "Write",
2009 "properties": { 1606 "properties": {
2010 "table": {
2011 "description": "Required. The table whose rows will be writt en.",
2012 "type": "string"
2013 },
2014 "columns": { 1607 "columns": {
2015 "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.", 1608 "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.",
2016 "items": { 1609 "items": {
2017 "type": "string" 1610 "type": "string"
2018 }, 1611 },
2019 "type": "array" 1612 "type": "array"
2020 }, 1613 },
2021 "values": { 1614 "values": {
2022 "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.", 1615 "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.",
2023 "items": { 1616 "items": {
2024 "items": { 1617 "items": {
2025 "type": "any" 1618 "type": "any"
2026 }, 1619 },
2027 "type": "array" 1620 "type": "array"
2028 }, 1621 },
2029 "type": "array" 1622 "type": "array"
1623 },
1624 "table": {
1625 "description": "Required. The table whose rows will be writt en.",
1626 "type": "string"
2030 } 1627 }
2031 }, 1628 },
2032 "type": "object" 1629 "type": "object"
2033 }, 1630 },
2034 "ReadWrite": { 1631 "ReadWrite": {
2035 "description": "Options for read-write transactions.", 1632 "description": "Options for read-write transactions.",
2036 "id": "ReadWrite", 1633 "id": "ReadWrite",
2037 "properties": {}, 1634 "properties": {},
2038 "type": "object" 1635 "type": "object"
2039 }, 1636 },
(...skipping 198 matching lines...) Expand 10 before | Expand all | Expand 10 after
2238 "format": "google-datetime", 1835 "format": "google-datetime",
2239 "type": "string" 1836 "type": "string"
2240 } 1837 }
2241 }, 1838 },
2242 "type": "object" 1839 "type": "object"
2243 }, 1840 },
2244 "ResultSetMetadata": { 1841 "ResultSetMetadata": {
2245 "description": "Metadata about a ResultSet or PartialResultSet.", 1842 "description": "Metadata about a ResultSet or PartialResultSet.",
2246 "id": "ResultSetMetadata", 1843 "id": "ResultSetMetadata",
2247 "properties": { 1844 "properties": {
1845 "transaction": {
1846 "$ref": "Transaction",
1847 "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here."
1848 },
2248 "rowType": { 1849 "rowType": {
2249 "$ref": "StructType", 1850 "$ref": "StructType",
2250 "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 ]" 1851 "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 ]"
2251 },
2252 "transaction": {
2253 "$ref": "Transaction",
2254 "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here."
2255 } 1852 }
2256 }, 1853 },
2257 "type": "object" 1854 "type": "object"
2258 }, 1855 },
2259 "TransactionSelector": { 1856 "TransactionSelector": {
2260 "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.", 1857 "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.",
2261 "id": "TransactionSelector", 1858 "id": "TransactionSelector",
2262 "properties": { 1859 "properties": {
2263 "singleUse": { 1860 "singleUse": {
2264 "$ref": "TransactionOptions", 1861 "$ref": "TransactionOptions",
2265 "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." 1862 "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."
2266 }, 1863 },
2267 "begin": { 1864 "begin": {
2268 "$ref": "TransactionOptions", 1865 "$ref": "TransactionOptions",
2269 "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." 1866 "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."
2270 }, 1867 },
2271 "id": { 1868 "id": {
2272 "description": "Execute the read or SQL query in a previousl y-started transaction.", 1869 "description": "Execute the read or SQL query in a previousl y-started transaction.",
2273 "format": "byte", 1870 "format": "byte",
2274 "type": "string" 1871 "type": "string"
2275 } 1872 }
2276 }, 1873 },
2277 "type": "object" 1874 "type": "object"
2278 }, 1875 },
2279 "KeySet": { 1876 "KeySet": {
2280 "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.", 1877 "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.",
2281 "id": "KeySet", 1878 "id": "KeySet",
2282 "properties": { 1879 "properties": {
1880 "ranges": {
1881 "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
1882 "items": {
1883 "$ref": "KeyRange"
1884 },
1885 "type": "array"
1886 },
2283 "keys": { 1887 "keys": {
2284 "description": "A list of specific keys. Entries in `keys` s hould have exactly as\nmany elements as there are columns in the primary or inde x key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.", 1888 "description": "A list of specific keys. Entries in `keys` s hould have exactly as\nmany elements as there are columns in the primary or inde x key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.",
2285 "items": { 1889 "items": {
2286 "items": { 1890 "items": {
2287 "type": "any" 1891 "type": "any"
2288 }, 1892 },
2289 "type": "array" 1893 "type": "array"
2290 }, 1894 },
2291 "type": "array" 1895 "type": "array"
2292 }, 1896 },
2293 "all": { 1897 "all": {
2294 "description": "For convenience `all` can be set to `true` t o indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.", 1898 "description": "For convenience `all` can be set to `true` t o indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.",
2295 "type": "boolean" 1899 "type": "boolean"
2296 },
2297 "ranges": {
2298 "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
2299 "items": {
2300 "$ref": "KeyRange"
2301 },
2302 "type": "array"
2303 } 1900 }
2304 }, 1901 },
2305 "type": "object" 1902 "type": "object"
2306 }, 1903 },
2307 "Mutation": { 1904 "Mutation": {
2308 "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.", 1905 "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.",
2309 "id": "Mutation", 1906 "id": "Mutation",
2310 "properties": { 1907 "properties": {
1908 "insert": {
1909 "$ref": "Write",
1910 "description": "Insert new rows in a table. If any of the ro ws already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
1911 },
1912 "insertOrUpdate": {
1913 "$ref": "Write",
1914 "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."
1915 },
1916 "update": {
1917 "$ref": "Write",
1918 "description": "Update existing rows in a table. If any of t he rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."
1919 },
2311 "replace": { 1920 "replace": {
2312 "$ref": "Write", 1921 "$ref": "Write",
2313 "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`." 1922 "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`."
2314 }, 1923 },
2315 "delete": { 1924 "delete": {
2316 "$ref": "Delete", 1925 "$ref": "Delete",
2317 "description": "Delete rows from a table. Succeeds whether o r not the named\nrows were present." 1926 "description": "Delete rows from a table. Succeeds whether o r not the named\nrows were present."
2318 },
2319 "insert": {
2320 "$ref": "Write",
2321 "description": "Insert new rows in a table. If any of the ro ws already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
2322 },
2323 "insertOrUpdate": {
2324 "$ref": "Write",
2325 "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."
2326 },
2327 "update": {
2328 "$ref": "Write",
2329 "description": "Update existing rows in a table. If any of t he rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."
2330 } 1927 }
2331 }, 1928 },
2332 "type": "object" 1929 "type": "object"
2333 }, 1930 },
2334 "GetDatabaseDdlResponse": { 1931 "GetDatabaseDdlResponse": {
2335 "description": "The response for GetDatabaseDdl.", 1932 "description": "The response for GetDatabaseDdl.",
2336 "id": "GetDatabaseDdlResponse", 1933 "id": "GetDatabaseDdlResponse",
2337 "properties": { 1934 "properties": {
2338 "statements": { 1935 "statements": {
2339 "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.", 1936 "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",
2340 "items": { 1937 "items": {
2341 "type": "string" 1938 "type": "string"
2342 }, 1939 },
1940 "type": "array"
1941 }
1942 },
1943 "type": "object"
1944 },
1945 "Database": {
1946 "description": "A Cloud Spanner database.",
1947 "id": "Database",
1948 "properties": {
1949 "state": {
1950 "description": "Output only. The current database state.",
1951 "enum": [
1952 "STATE_UNSPECIFIED",
1953 "CREATING",
1954 "READY"
1955 ],
1956 "enumDescriptions": [
1957 "Not specified.",
1958 "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.",
1959 "The database is fully created and ready for use."
1960 ],
1961 "type": "string"
1962 },
1963 "name": {
1964 "description": "Required. The name of the database. Values a re of the form\n`projects/<project>/instances/<instance>/databases/<database>`,\ nwhere `<database>` is as specified in the `CREATE DATABASE`\nstatement. This na me can be passed to other API methods to\nidentify the database.",
1965 "type": "string"
1966 }
1967 },
1968 "type": "object"
1969 },
1970 "ListDatabasesResponse": {
1971 "description": "The response for ListDatabases.",
1972 "id": "ListDatabasesResponse",
1973 "properties": {
1974 "nextPageToken": {
1975 "description": "`next_page_token` can be sent in a subsequen t\nListDatabases call to fetch more\nof the matching databases.",
1976 "type": "string"
1977 },
1978 "databases": {
1979 "description": "Databases that matched the request.",
1980 "items": {
1981 "$ref": "Database"
1982 },
1983 "type": "array"
1984 }
1985 },
1986 "type": "object"
1987 },
1988 "SetIamPolicyRequest": {
1989 "description": "Request message for `SetIamPolicy` method.",
1990 "id": "SetIamPolicyRequest",
1991 "properties": {
1992 "updateMask": {
1993 "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, a default\nmask is used:\npaths: \"bindings, etag\"\nThis fiel d is only used by Cloud IAM.",
1994 "format": "google-fieldmask",
1995 "type": "string"
1996 },
1997 "policy": {
1998 "$ref": "Policy",
1999 "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."
2000 }
2001 },
2002 "type": "object"
2003 },
2004 "Instance": {
2005 "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
2006 "id": "Instance",
2007 "properties": {
2008 "labels": {
2009 "additionalProperties": {
2010 "type": "string"
2011 },
2012 "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.",
2013 "type": "object"
2014 },
2015 "config": {
2016 "description": "Required. The name of the instance's configu ration. Values are of the form\n`projects/<project>/instanceConfigs/<configurati on>`. See\nalso InstanceConfig and\nListInstanceConfigs.",
2017 "type": "string"
2018 },
2019 "state": {
2020 "description": "Output only. The current instance state. For \nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nU pdateInstance, the state must be\neither omitted or set to `READY`.",
2021 "enum": [
2022 "STATE_UNSPECIFIED",
2023 "CREATING",
2024 "READY"
2025 ],
2026 "enumDescriptions": [
2027 "Not specified.",
2028 "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",
2029 "The instance is fully created and ready to do work such as\ncreating databases."
2030 ],
2031 "type": "string"
2032 },
2033 "name": {
2034 "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.",
2035 "type": "string"
2036 },
2037 "displayName": {
2038 "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.",
2039 "type": "string"
2040 },
2041 "nodeCount": {
2042 "description": "Required. The number of nodes allocated to t his instance.",
2043 "format": "int32",
2044 "type": "integer"
2045 }
2046 },
2047 "type": "object"
2048 },
2049 "RollbackRequest": {
2050 "description": "The request for Rollback.",
2051 "id": "RollbackRequest",
2052 "properties": {
2053 "transactionId": {
2054 "description": "Required. The transaction to roll back.",
2055 "format": "byte",
2056 "type": "string"
2057 }
2058 },
2059 "type": "object"
2060 },
2061 "Transaction": {
2062 "description": "A transaction.",
2063 "id": "Transaction",
2064 "properties": {
2065 "readTimestamp": {
2066 "description": "For snapshot read-only transactions, the rea d timestamp chosen\nfor the transaction. Not returned by default: see\nTransacti onOptions.ReadOnly.return_read_timestamp.",
2067 "format": "google-datetime",
2068 "type": "string"
2069 },
2070 "id": {
2071 "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use re ad-only transactions do not have IDs, because\nsingle-use transactions do not su pport multiple requests.",
2072 "format": "byte",
2073 "type": "string"
2074 }
2075 },
2076 "type": "object"
2077 },
2078 "UpdateDatabaseDdlMetadata": {
2079 "description": "Metadata type for the operation returned by\nUpdateD atabaseDdl.",
2080 "id": "UpdateDatabaseDdlMetadata",
2081 "properties": {
2082 "statements": {
2083 "description": "For an update this list contains all the sta tements. For an\nindividual statement, this list contains only that statement.",
2084 "items": {
2085 "type": "string"
2086 },
2087 "type": "array"
2088 },
2089 "commitTimestamps": {
2090 "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]`.",
2091 "items": {
2092 "format": "google-datetime",
2093 "type": "string"
2094 },
2095 "type": "array"
2096 },
2097 "database": {
2098 "description": "The database being modified.",
2099 "type": "string"
2100 }
2101 },
2102 "type": "object"
2103 },
2104 "CounterOptions": {
2105 "description": "Options for counters",
2106 "id": "CounterOptions",
2107 "properties": {
2108 "metric": {
2109 "description": "The metric to update.",
2110 "type": "string"
2111 },
2112 "field": {
2113 "description": "The field value to attribute.",
2114 "type": "string"
2115 }
2116 },
2117 "type": "object"
2118 },
2119 "QueryPlan": {
2120 "description": "Contains an ordered list of nodes appearing in the q uery plan.",
2121 "id": "QueryPlan",
2122 "properties": {
2123 "planNodes": {
2124 "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresp onds to its index in\n`plan_nodes`.",
2125 "items": {
2126 "$ref": "PlanNode"
2127 },
2128 "type": "array"
2129 }
2130 },
2131 "type": "object"
2132 },
2133 "StructType": {
2134 "description": "`StructType` defines the fields of a STRUCT type.",
2135 "id": "StructType",
2136 "properties": {
2137 "fields": {
2138 "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nl ists, where the order of field values matches the order of\nfields in the Struct Type. In turn, the order of fields\nmatches the order of columns in a read reque st, or the order of\nfields in the `SELECT` clause of a query.",
2139 "items": {
2140 "$ref": "Field"
2141 },
2142 "type": "array"
2143 }
2144 },
2145 "type": "object"
2146 },
2147 "Field": {
2148 "description": "Message representing a single field of a struct.",
2149 "id": "Field",
2150 "properties": {
2151 "type": {
2152 "$ref": "Type",
2153 "description": "The type of the field."
2154 },
2155 "name": {
2156 "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.",
2157 "type": "string"
2158 }
2159 },
2160 "type": "object"
2161 },
2162 "ResultSetStats": {
2163 "description": "Additional statistics about a ResultSet or PartialRe sultSet.",
2164 "id": "ResultSetStats",
2165 "properties": {
2166 "queryPlan": {
2167 "$ref": "QueryPlan",
2168 "description": "QueryPlan for the query associated with this result."
2169 },
2170 "queryStats": {
2171 "additionalProperties": {
2172 "description": "Properties of the object.",
2173 "type": "any"
2174 },
2175 "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
2176 "type": "object"
2177 }
2178 },
2179 "type": "object"
2180 },
2181 "TestIamPermissionsRequest": {
2182 "description": "Request message for `TestIamPermissions` method.",
2183 "id": "TestIamPermissionsRequest",
2184 "properties": {
2185 "permissions": {
2186 "description": "REQUIRED: The set of permissions to check fo r 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.in stances.*') are not allowed.",
2187 "items": {
2188 "type": "string"
2189 },
2343 "type": "array" 2190 "type": "array"
2344 } 2191 }
2345 }, 2192 },
2346 "type": "object" 2193 "type": "object"
2347 }, 2194 },
2348 "Database": { 2195 "CommitResponse": {
2349 "description": "A Cloud Spanner database.", 2196 "description": "The response for Commit.",
2350 "id": "Database", 2197 "id": "CommitResponse",
2351 "properties": { 2198 "properties": {
2352 "state": { 2199 "commitTimestamp": {
2353 "description": "Output only. The current database state.", 2200 "description": "The Cloud Spanner timestamp at which the tra nsaction committed.",
2201 "format": "google-datetime",
2202 "type": "string"
2203 }
2204 },
2205 "type": "object"
2206 },
2207 "Type": {
2208 "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
2209 "id": "Type",
2210 "properties": {
2211 "arrayElementType": {
2212 "$ref": "Type",
2213 "description": "If code == ARRAY, then `array_element_type`\ nis the type of the array elements."
2214 },
2215 "code": {
2216 "description": "Required. The TypeCode for this type.",
2354 "enum": [ 2217 "enum": [
2355 "STATE_UNSPECIFIED", 2218 "TYPE_CODE_UNSPECIFIED",
2356 "CREATING", 2219 "BOOL",
2357 "READY" 2220 "INT64",
2221 "FLOAT64",
2222 "TIMESTAMP",
2223 "DATE",
2224 "STRING",
2225 "BYTES",
2226 "ARRAY",
2227 "STRUCT"
2358 ], 2228 ],
2359 "enumDescriptions": [ 2229 "enumDescriptions": [
2360 "Not specified.", 2230 "Not specified.",
2361 "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.", 2231 "Encoded as JSON `true` or `false`.",
2362 "The database is fully created and ready for use." 2232 "Encoded as `string`, in decimal format.",
2363 ], 2233 "Encoded as `number`, or the strings `\"NaN\"`, `\"Infin ity\"`, or\n`\"-Infinity\"`.",
2364 "type": "string" 2234 "Encoded as `string` in RFC 3339 timestamp format. The t ime zone\nmust be present, and must be `\"Z\"`.",
2365 }, 2235 "Encoded as `string` in RFC 3339 date format.",
2366 "name": { 2236 "Encoded as `string`.",
2367 "description": "Required. The name of the database. Values a re of the form\n`projects/<project>/instances/<instance>/databases/<database>`,\ nwhere `<database>` is as specified in the `CREATE DATABASE`\nstatement. This na me can be passed to other API methods to\nidentify the database.", 2237 "Encoded as a base64-encoded `string`, as described in R FC 4648,\nsection 4.",
2368 "type": "string" 2238 "Encoded as `list`, where the list elements are represen ted\naccording to array_element_type.",
2369 } 2239 "Encoded as `list`, where list element `i` is represente d according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
2370 }, 2240 ],
2371 "type": "object" 2241 "type": "string"
2372 }, 2242 },
2373 "Instance": { 2243 "structType": {
2374 "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.", 2244 "$ref": "StructType",
2375 "id": "Instance", 2245 "description": "If code == STRUCT, then `struct_type`\nprovi des type information for the struct's fields."
2376 "properties": { 2246 }
2377 "labels": { 2247 },
2378 "additionalProperties": { 2248 "type": "object"
2379 "type": "string" 2249 },
2380 }, 2250 "PlanNode": {
2381 "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.", 2251 "description": "Node information for nodes appearing in a QueryPlan. plan_nodes.",
2382 "type": "object" 2252 "id": "PlanNode",
2383 }, 2253 "properties": {
2384 "config": { 2254 "kind": {
2385 "description": "Required. The name of the instance's configu ration. Values are of the form\n`projects/<project>/instanceConfigs/<configurati on>`. See\nalso InstanceConfig and\nListInstanceConfigs.", 2255 "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.",
2386 "type": "string"
2387 },
2388 "state": {
2389 "description": "Output only. The current instance state. For \nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nU pdateInstance, the state must be\neither omitted or set to `READY`.",
2390 "enum": [ 2256 "enum": [
2391 "STATE_UNSPECIFIED", 2257 "KIND_UNSPECIFIED",
2392 "CREATING", 2258 "RELATIONAL",
2393 "READY" 2259 "SCALAR"
2394 ], 2260 ],
2395 "enumDescriptions": [ 2261 "enumDescriptions": [
2396 "Not specified.", 2262 "Not specified.",
2397 "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.", 2263 "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.",
2398 "The instance is fully created and ready to do work such as\ncreating databases." 2264 "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."
2399 ], 2265 ],
2400 "type": "string"
2401 },
2402 "name": {
2403 "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.",
2404 "type": "string" 2266 "type": "string"
2405 }, 2267 },
2406 "displayName": { 2268 "displayName": {
2407 "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.", 2269 "description": "The display name for the node.",
2408 "type": "string" 2270 "type": "string"
2409 }, 2271 },
2410 "nodeCount": { 2272 "childLinks": {
2411 "description": "Required. The number of nodes allocated to t his instance.", 2273 "description": "List of child node `index`es and their relat ionship to this parent.",
2274 "items": {
2275 "$ref": "ChildLink"
2276 },
2277 "type": "array"
2278 },
2279 "metadata": {
2280 "additionalProperties": {
2281 "description": "Properties of the object.",
2282 "type": "any"
2283 },
2284 "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 }",
2285 "type": "object"
2286 },
2287 "executionStats": {
2288 "additionalProperties": {
2289 "description": "Properties of the object.",
2290 "type": "any"
2291 },
2292 "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.",
2293 "type": "object"
2294 },
2295 "shortRepresentation": {
2296 "$ref": "ShortRepresentation",
2297 "description": "Condensed representation for SCALAR nodes."
2298 },
2299 "index": {
2300 "description": "The `PlanNode`'s index in node list.",
2412 "format": "int32", 2301 "format": "int32",
2413 "type": "integer" 2302 "type": "integer"
2414 } 2303 }
2415 }, 2304 },
2416 "type": "object" 2305 "type": "object"
2417 }, 2306 },
2418 "SetIamPolicyRequest": { 2307 "CreateInstanceMetadata": {
2419 "description": "Request message for `SetIamPolicy` method.", 2308 "description": "Metadata type for the operation returned by\nCreateI nstance.",
2420 "id": "SetIamPolicyRequest", 2309 "id": "CreateInstanceMetadata",
2421 "properties": { 2310 "properties": {
2422 "policy": { 2311 "cancelTime": {
2423 "$ref": "Policy", 2312 "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.",
2424 "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." 2313 "format": "google-datetime",
2425 }, 2314 "type": "string"
2426 "updateMask": { 2315 },
2427 "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, a default\nmask is used:\npaths: \"bindings, etag\"\nThis fiel d is only used by Cloud IAM.", 2316 "endTime": {
2428 "format": "google-fieldmask", 2317 "description": "The time at which this operation failed or w as completed successfully.",
2429 "type": "string" 2318 "format": "google-datetime",
2430 } 2319 "type": "string"
2431 }, 2320 },
2432 "type": "object" 2321 "instance": {
2433 }, 2322 "$ref": "Instance",
2434 "ListDatabasesResponse": { 2323 "description": "The instance being created."
2435 "description": "The response for ListDatabases.", 2324 },
2436 "id": "ListDatabasesResponse", 2325 "startTime": {
2326 "description": "The time at which the\nCreateInstance reques t was\nreceived.",
2327 "format": "google-datetime",
2328 "type": "string"
2329 }
2330 },
2331 "type": "object"
2332 },
2333 "AuditConfig": {
2334 "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, ar e exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs." ,
2335 "id": "AuditConfig",
2336 "properties": {
2337 "auditLogConfigs": {
2338 "description": "The configuration for logging of each type o f permission.\nNext ID: 4",
2339 "items": {
2340 "$ref": "AuditLogConfig"
2341 },
2342 "type": "array"
2343 },
2344 "exemptedMembers": {
2345 "description": "Specifies the identities that are exempted f rom \"data access\" audit\nlogging for the `service` specified above.\nFollows t he same format of Binding.members.\nThis field is deprecated in favor of per-per mission-type exemptions.",
2346 "items": {
2347 "type": "string"
2348 },
2349 "type": "array"
2350 },
2351 "service": {
2352 "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServ ices` is a special value that covers all services.",
2353 "type": "string"
2354 }
2355 },
2356 "type": "object"
2357 },
2358 "ChildLink": {
2359 "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
2360 "id": "ChildLink",
2361 "properties": {
2362 "type": {
2363 "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.",
2364 "type": "string"
2365 },
2366 "childIndex": {
2367 "description": "The node to which the link points.",
2368 "format": "int32",
2369 "type": "integer"
2370 },
2371 "variable": {
2372 "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.",
2373 "type": "string"
2374 }
2375 },
2376 "type": "object"
2377 },
2378 "CloudAuditOptions": {
2379 "description": "Write a Cloud Audit log",
2380 "id": "CloudAuditOptions",
2381 "properties": {},
2382 "type": "object"
2383 },
2384 "Delete": {
2385 "description": "Arguments to delete operations.",
2386 "id": "Delete",
2387 "properties": {
2388 "table": {
2389 "description": "Required. The table whose rows will be delet ed.",
2390 "type": "string"
2391 },
2392 "keySet": {
2393 "$ref": "KeySet",
2394 "description": "Required. The primary keys of the rows withi n table to delete."
2395 }
2396 },
2397 "type": "object"
2398 },
2399 "CommitRequest": {
2400 "description": "The request for Commit.",
2401 "id": "CommitRequest",
2402 "properties": {
2403 "singleUseTransaction": {
2404 "$ref": "TransactionOptions",
2405 "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."
2406 },
2407 "mutations": {
2408 "description": "The mutations to be executed when this trans action commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
2409 "items": {
2410 "$ref": "Mutation"
2411 },
2412 "type": "array"
2413 },
2414 "transactionId": {
2415 "description": "Commit a previously-started transaction.",
2416 "format": "byte",
2417 "type": "string"
2418 }
2419 },
2420 "type": "object"
2421 },
2422 "BeginTransactionRequest": {
2423 "description": "The request for BeginTransaction.",
2424 "id": "BeginTransactionRequest",
2425 "properties": {
2426 "options": {
2427 "$ref": "TransactionOptions",
2428 "description": "Required. Options for the new transaction."
2429 }
2430 },
2431 "type": "object"
2432 },
2433 "ListInstanceConfigsResponse": {
2434 "description": "The response for ListInstanceConfigs.",
2435 "id": "ListInstanceConfigsResponse",
2437 "properties": { 2436 "properties": {
2438 "nextPageToken": { 2437 "nextPageToken": {
2439 "description": "`next_page_token` can be sent in a subsequen t\nListDatabases call to fetch more\nof the matching databases.", 2438 "description": "`next_page_token` can be sent in a subsequen t\nListInstanceConfigs call to\nfetch more of the matching instance configuratio ns.",
2440 "type": "string" 2439 "type": "string"
2441 }, 2440 },
2442 "databases": { 2441 "instanceConfigs": {
2443 "description": "Databases that matched the request.", 2442 "description": "The list of requested instance configuration s.",
2444 "items": { 2443 "items": {
2445 "$ref": "Database" 2444 "$ref": "InstanceConfig"
2446 }, 2445 },
2447 "type": "array" 2446 "type": "array"
2448 } 2447 }
2449 }, 2448 },
2450 "type": "object" 2449 "type": "object"
2451 }, 2450 },
2452 "RollbackRequest": { 2451 "GetIamPolicyRequest": {
2453 "description": "The request for Rollback.", 2452 "description": "Request message for `GetIamPolicy` method.",
2454 "id": "RollbackRequest", 2453 "id": "GetIamPolicyRequest",
2455 "properties": { 2454 "properties": {},
2456 "transactionId": { 2455 "type": "object"
2457 "description": "Required. The transaction to roll back.", 2456 },
2458 "format": "byte", 2457 "TestIamPermissionsResponse": {
2459 "type": "string" 2458 "description": "Response message for `TestIamPermissions` method.",
2460 } 2459 "id": "TestIamPermissionsResponse",
2461 }, 2460 "properties": {
2462 "type": "object" 2461 "permissions": {
2463 }, 2462 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.",
2464 "Transaction": {
2465 "description": "A transaction.",
2466 "id": "Transaction",
2467 "properties": {
2468 "readTimestamp": {
2469 "description": "For snapshot read-only transactions, the rea d timestamp chosen\nfor the transaction. Not returned by default: see\nTransacti onOptions.ReadOnly.return_read_timestamp.",
2470 "format": "google-datetime",
2471 "type": "string"
2472 },
2473 "id": {
2474 "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use re ad-only transactions do not have IDs, because\nsingle-use transactions do not su pport multiple requests.",
2475 "format": "byte",
2476 "type": "string"
2477 }
2478 },
2479 "type": "object"
2480 },
2481 "UpdateDatabaseDdlMetadata": {
2482 "description": "Metadata type for the operation returned by\nUpdateD atabaseDdl.",
2483 "id": "UpdateDatabaseDdlMetadata",
2484 "properties": {
2485 "database": {
2486 "description": "The database being modified.",
2487 "type": "string"
2488 },
2489 "statements": {
2490 "description": "For an update this list contains all the sta tements. For an\nindividual statement, this list contains only that statement.",
2491 "items": { 2463 "items": {
2492 "type": "string" 2464 "type": "string"
2493 }, 2465 },
2494 "type": "array" 2466 "type": "array"
2495 },
2496 "commitTimestamps": {
2497 "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]`.",
2498 "items": {
2499 "format": "google-datetime",
2500 "type": "string"
2501 },
2502 "type": "array"
2503 } 2467 }
2504 }, 2468 },
2505 "type": "object" 2469 "type": "object"
2506 }, 2470 },
2507 "CounterOptions": { 2471 "CreateDatabaseMetadata": {
2508 "description": "Options for counters", 2472 "description": "Metadata type for the operation returned by\nCreateD atabase.",
2509 "id": "CounterOptions", 2473 "id": "CreateDatabaseMetadata",
2510 "properties": { 2474 "properties": {
2511 "metric": { 2475 "database": {
2512 "description": "The metric to update.", 2476 "description": "The database being created.",
2513 "type": "string"
2514 },
2515 "field": {
2516 "description": "The field value to attribute.",
2517 "type": "string" 2477 "type": "string"
2518 } 2478 }
2519 }, 2479 },
2520 "type": "object" 2480 "type": "object"
2521 }, 2481 },
2522 "QueryPlan": { 2482 "Rule": {
2523 "description": "Contains an ordered list of nodes appearing in the q uery plan.", 2483 "description": "A rule to be applied in a Policy.",
2524 "id": "QueryPlan", 2484 "id": "Rule",
2525 "properties": { 2485 "properties": {
2526 "planNodes": { 2486 "notIn": {
2527 "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresp onds to its index in\n`plan_nodes`.", 2487 "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).",
2528 "items": { 2488 "items": {
2529 "$ref": "PlanNode" 2489 "type": "string"
2530 }, 2490 },
2531 "type": "array" 2491 "type": "array"
2492 },
2493 "description": {
2494 "description": "Human-readable description of the rule.",
2495 "type": "string"
2496 },
2497 "conditions": {
2498 "description": "Additional restrictions that must be met",
2499 "items": {
2500 "$ref": "Condition"
2501 },
2502 "type": "array"
2503 },
2504 "logConfig": {
2505 "description": "The config returned to callers of tech.iam.I AM.CheckPolicy for any entries\nthat match the LOG action.",
2506 "items": {
2507 "$ref": "LogConfig"
2508 },
2509 "type": "array"
2510 },
2511 "in": {
2512 "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.",
2513 "items": {
2514 "type": "string"
2515 },
2516 "type": "array"
2517 },
2518 "permissions": {
2519 "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.",
2520 "items": {
2521 "type": "string"
2522 },
2523 "type": "array"
2524 },
2525 "action": {
2526 "description": "Required",
2527 "enum": [
2528 "NO_ACTION",
2529 "ALLOW",
2530 "ALLOW_WITH_LOG",
2531 "DENY",
2532 "DENY_WITH_LOG",
2533 "LOG"
2534 ],
2535 "enumDescriptions": [
2536 "Default no action.",
2537 "Matching 'Entries' grant access.",
2538 "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
2539 "Matching 'Entries' deny access.",
2540 "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
2541 "Matching 'Entries' tell IAM.Check callers to generate l ogs."
2542 ],
2543 "type": "string"
2532 } 2544 }
2533 }, 2545 },
2534 "type": "object" 2546 "type": "object"
2535 }, 2547 },
2536 "StructType": { 2548 "LogConfig": {
2537 "description": "`StructType` defines the fields of a STRUCT type.", 2549 "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",
2538 "id": "StructType", 2550 "id": "LogConfig",
2539 "properties": { 2551 "properties": {
2540 "fields": { 2552 "dataAccess": {
2541 "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nl ists, where the order of field values matches the order of\nfields in the Struct Type. In turn, the order of fields\nmatches the order of columns in a read reque st, or the order of\nfields in the `SELECT` clause of a query.", 2553 "$ref": "DataAccessOptions",
2542 "items": { 2554 "description": "Data access options."
2543 "$ref": "Field" 2555 },
2544 }, 2556 "cloudAudit": {
2545 "type": "array" 2557 "$ref": "CloudAuditOptions",
2558 "description": "Cloud audit options."
2559 },
2560 "counter": {
2561 "$ref": "CounterOptions",
2562 "description": "Counter options."
2546 } 2563 }
2547 }, 2564 },
2548 "type": "object" 2565 "type": "object"
2549 },
2550 "Field": {
2551 "description": "Message representing a single field of a struct.",
2552 "id": "Field",
2553 "properties": {
2554 "name": {
2555 "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.",
2556 "type": "string"
2557 },
2558 "type": {
2559 "$ref": "Type",
2560 "description": "The type of the field."
2561 }
2562 },
2563 "type": "object"
2564 } 2566 }
2565 }, 2567 },
2566 "servicePath": "", 2568 "servicePath": "",
2567 "title": "Cloud Spanner API", 2569 "title": "Cloud Spanner API",
2568 "version": "v1" 2570 "version": "v1"
2569 } 2571 }
OLDNEW
« no previous file with comments | « discovery/googleapis/sourcerepo__v1.json ('k') | discovery/googleapis/storage__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698