discovery/googleapis/spanner__v1.json - Issue 2779563003: Api-roll 47: 2017-03-27

Unified Diff: discovery/googleapis/spanner__v1.json

Issue 2779563003: Api-roll 47: 2017-03-27 (Closed)

Patch Set: Created 3 years, 9 months ago

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

Jump to:

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

Index: discovery/googleapis/spanner__v1.json

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

index a8134bc504c000b2739ac24cabcc86877e68313f..c37ca5d2b6c1bce8977c34ba27a617ff42a35de6 100644

--- a/discovery/googleapis/spanner__v1.json

+++ b/discovery/googleapis/spanner__v1.json

@@ -25,24 +25,8 @@

"ownerDomain": "google.com",

"ownerName": "Google",

"parameters": {

- "upload_protocol": {

- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",

- "location": "query",

- "type": "string"

- },

- "prettyPrint": {

- "default": "true",

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

- "location": "query",

- "type": "boolean"

- },

- "fields": {

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

- "location": "query",

- "type": "string"

- },

- "uploadType": {

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

+ "callback": {

+ "description": "JSONP",

"location": "query",

"type": "string"

@@ -59,11 +43,6 @@

"location": "query",

"type": "string"

- "callback": {

- "description": "JSONP",

- "location": "query",

- "type": "string"

- },

"alt": {

"default": "json",

"description": "Data format for response.",

@@ -80,13 +59,13 @@

"location": "query",

"type": "string"

- "access_token": {

- "description": "OAuth access token.",

+ "key": {

+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",

"location": "query",

"type": "string"

- "key": {

- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",

+ "access_token": {

+ "description": "OAuth access token.",

"location": "query",

"type": "string"

@@ -101,13 +80,34 @@

"location": "query",

"type": "boolean"

+ "bearer_token": {

+ "description": "OAuth bearer token.",

+ "location": "query",

+ "type": "string"

+ },

"oauth_token": {

"description": "OAuth 2.0 token for the current user.",

"location": "query",

"type": "string"

- "bearer_token": {

- "description": "OAuth bearer token.",

+ "upload_protocol": {

+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",

+ "location": "query",

+ "type": "string"

+ },

+ "prettyPrint": {

+ "default": "true",

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

+ "location": "query",

+ "type": "boolean"

+ },

+ "uploadType": {

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

+ "location": "query",

+ "type": "string"

+ },

+ "fields": {

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

"location": "query",

"type": "string"

}

@@ -116,152 +116,8 @@

"resources": {

"projects": {

"resources": {

- "instanceConfigs": {

- "methods": {

- "list": {

- "description": "Lists the supported instance configurations for a given project.",

- "httpMethod": "GET",

- "id": "spanner.projects.instanceConfigs.list",

- "parameterOrder": [

- "parent"

- ],

- "parameters": {

- "pageToken": {

- "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",

- "location": "query",

- "type": "string"

- },

- "pageSize": {

- "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",

- "format": "int32",

- "location": "query",

- "type": "integer"

- },

- "parent": {

- "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/<project>`.",

- "location": "path",

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

- "required": true,

- "type": "string"

- }

- },

- "path": "v1/{+parent}/instanceConfigs",

- "response": {

- "$ref": "ListInstanceConfigsResponse"

- },

- "scopes": [

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

- ]

- },

- "get": {

- "description": "Gets information about a particular instance configuration.",

- "httpMethod": "GET",

- "id": "spanner.projects.instanceConfigs.get",

- "parameterOrder": [

- "name"

- ],

- "parameters": {

- "name": {

- "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/<project>/instanceConfigs/<config>`.",

- "location": "path",

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

- "required": true,

- "type": "string"

- }

- },

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

- "response": {

- "$ref": "InstanceConfig"

- },

- "scopes": [

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

- ]

- }

- },

"instances": {

"methods": {

- "setIamPolicy": {

- "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.setIamPolicy",

- "parameterOrder": [

- "resource"

- ],

- "parameters": {

- "resource": {

- "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>/instances/<instance ID>/databases/<database ID>` for databases resources.",

- "location": "path",

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

- "required": true,

- "type": "string"

- }

- },

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

- "request": {

- "$ref": "SetIamPolicyRequest"

- },

- "response": {

- "$ref": "Policy"

- },

- "scopes": [

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

- ]

- },

- "create": {

- "description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track 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 instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\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 API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation 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 is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.create",

- "parameterOrder": [

- "parent"

- ],

- "parameters": {

- "parent": {

- "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/<project>`.",

- "location": "path",

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

- "required": true,

- "type": "string"

- }

- },

- "path": "v1/{+parent}/instances",

- "request": {

- "$ref": "CreateInstanceRequest"

- },

- "response": {

- "$ref": "Operation"

- },

- "scopes": [

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

- ]

- },

- "getIamPolicy": {

- "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.getIamPolicy",

- "parameterOrder": [

- "resource"

- ],

- "parameters": {

- "resource": {

- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources.",

- "location": "path",

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

- "required": true,

- "type": "string"

- }

- },

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

- "request": {

- "$ref": "GetIamPolicyRequest"

- },

- "response": {

- "$ref": "Policy"

- },

- "scopes": [

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

- ]

- },

"patch": {

"description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets 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\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\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 `<instance_name>/operations/<operation_id>` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name.",

"httpMethod": "PATCH",

@@ -372,6 +228,11 @@

"parent"

"parameters": {

+ "filter": {

+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * name\n * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --> The instance has a name.\n * name:Howl --> The instance's name contains the string \"howl\".\n * name:HOWL --> Equivalent to above.\n * NAME:howl --> Equivalent to above.\n * labels.env:* --> The instance has the label \"env\".\n * labels.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 containing \"dev\".",

+ "location": "query",

+ "type": "string"

+ },

"pageToken": {

"description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",

"location": "query",

@@ -389,11 +250,6 @@

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

"required": true,

"type": "string"

- },

- "filter": {

- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * name\n * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --> The instance has a name.\n * name:Howl --> The instance's name contains the string \"howl\".\n * name:HOWL --> Equivalent to above.\n * NAME:howl --> Equivalent to above.\n * labels.env:* --> The instance has the label \"env\".\n * labels.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 containing \"dev\".",

- "location": "query",

- "type": "string"

}

"path": "v1/{+parent}/instances",

@@ -403,50 +259,179 @@

"scopes": [

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

]

- }

- },

- "resources": {

- "databases": {

- "methods": {

- "updateDdl": {

- "description": "Updates the schema of a Cloud 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 schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",

- "httpMethod": "PATCH",

- "id": "spanner.projects.instances.databases.updateDdl",

- "parameterOrder": [

- "database"

- ],

- "parameters": {

- "database": {

- "description": "Required. The database to update.",

- "location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",

- "required": true,

- "type": "string"

- }

- },

- "path": "v1/{+database}/ddl",

- "request": {

- "$ref": "UpdateDatabaseDdlRequest"

- },

- "response": {

- "$ref": "Operation"

- },

- "scopes": [

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

- ]

- },

- "testIamPermissions": {

- "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.databases.testIamPermissions",

- "parameterOrder": [

- "resource"

- ],

- "parameters": {

- "resource": {

- "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources.",

- "location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",

+ },

+ "setIamPolicy": {

+ "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.setIamPolicy",

+ "parameterOrder": [

+ "resource"

+ ],

+ "parameters": {

+ "resource": {

+ "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>/instances/<instance ID>/databases/<database ID>` for databases resources.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

+ "path": "v1/{+resource}:setIamPolicy",

+ "request": {

+ "$ref": "SetIamPolicyRequest"

+ },

+ "response": {

+ "$ref": "Policy"

+ },

+ "scopes": [

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

+ ]

+ },

+ "create": {

+ "description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track 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 instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\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 API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation 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 is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.create",

+ "parameterOrder": [

+ "parent"

+ ],

+ "parameters": {

+ "parent": {

+ "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/<project>`.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

+ "path": "v1/{+parent}/instances",

+ "request": {

+ "$ref": "CreateInstanceRequest"

+ },

+ "response": {

+ "$ref": "Operation"

+ },

+ "scopes": [

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

+ ]

+ },

+ "getIamPolicy": {

+ "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.getIamPolicy",

+ "parameterOrder": [

+ "resource"

+ ],

+ "parameters": {

+ "resource": {

+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

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

+ "request": {

+ "$ref": "GetIamPolicyRequest"

+ },

+ "response": {

+ "$ref": "Policy"

+ },

+ "scopes": [

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

+ ]

+ }

+ },

+ "resources": {

+ "databases": {

+ "methods": {

+ "get": {

+ "description": "Gets the state of a Cloud Spanner database.",

+ "httpMethod": "GET",

+ "id": "spanner.projects.instances.databases.get",

+ "parameterOrder": [

+ "name"

+ ],

+ "parameters": {

+ "name": {

+ "description": "Required. The name of the requested database. Values are of the form\n`projects/<project>/instances/<instance>/databases/<database>`.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

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

+ "response": {

+ "$ref": "Database"

+ },

+ "scopes": [

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

+ ]

+ },

+ "dropDatabase": {

+ "description": "Drops (aka deletes) a Cloud Spanner database.",

+ "httpMethod": "DELETE",

+ "id": "spanner.projects.instances.databases.dropDatabase",

+ "parameterOrder": [

+ "database"

+ ],

+ "parameters": {

+ "database": {

+ "description": "Required. The database to be dropped.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

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

+ "response": {

+ "$ref": "Empty"

+ },

+ "scopes": [

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

+ ]

+ },

+ "updateDdl": {

+ "description": "Updates the schema of a Cloud 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 schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",

+ "httpMethod": "PATCH",

+ "id": "spanner.projects.instances.databases.updateDdl",

+ "parameterOrder": [

+ "database"

+ ],

+ "parameters": {

+ "database": {

+ "description": "Required. The database to update.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

+ "path": "v1/{+database}/ddl",

+ "request": {

+ "$ref": "UpdateDatabaseDdlRequest"

+ },

+ "response": {

+ "$ref": "Operation"

+ },

+ "scopes": [

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

+ ]

+ },

+ "testIamPermissions": {

+ "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.databases.testIamPermissions",

+ "parameterOrder": [

+ "resource"

+ ],

+ "parameters": {

+ "resource": {

+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources.",

+ "location": "path",

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

"required": true,

"type": "string"

}

@@ -494,6 +479,12 @@

"parent"

"parameters": {

+ "pageSize": {

+ "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",

+ "format": "int32",

+ "location": "query",

+ "type": "integer"

+ },

"parent": {

"description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/<project>/instances/<instance>`.",

"location": "path",

@@ -505,12 +496,6 @@

"description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",

"location": "query",

"type": "string"

- },

- "pageSize": {

- "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",

- "format": "int32",

- "location": "query",

- "type": "integer"

}

"path": "v1/{+parent}/databases",

@@ -521,55 +506,55 @@

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

]

- "create": {

- "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation 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.",

+ "setIamPolicy": {

+ "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",

"httpMethod": "POST",

- "id": "spanner.projects.instances.databases.create",

+ "id": "spanner.projects.instances.databases.setIamPolicy",

"parameterOrder": [

- "parent"

+ "resource"

"parameters": {

- "parent": {

- "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/<project>/instances/<instance>`.",

+ "resource": {

"location": "path",

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

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

"required": true,

"type": "string"

}

- "path": "v1/{+parent}/databases",

+ "path": "v1/{+resource}:setIamPolicy",

"request": {

- "$ref": "CreateDatabaseRequest"

+ "$ref": "SetIamPolicyRequest"

"response": {

- "$ref": "Operation"

+ "$ref": "Policy"

"scopes": [

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

]

- "setIamPolicy": {

- "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",

+ "create": {

+ "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation 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.",

"httpMethod": "POST",

- "id": "spanner.projects.instances.databases.setIamPolicy",

+ "id": "spanner.projects.instances.databases.create",

"parameterOrder": [

- "resource"

+ "parent"

"parameters": {

- "resource": {

+ "parent": {

+ "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/<project>/instances/<instance>`.",

"location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",

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

"required": true,

"type": "string"

}

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

+ "path": "v1/{+parent}/databases",

"request": {

- "$ref": "SetIamPolicyRequest"

+ "$ref": "CreateDatabaseRequest"

"response": {

- "$ref": "Policy"

+ "$ref": "Operation"

"scopes": [

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

@@ -601,107 +586,11 @@

"scopes": [

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

]

- },

- "get": {

- "description": "Gets the state of a Cloud Spanner database.",

- "httpMethod": "GET",

- "id": "spanner.projects.instances.databases.get",

- "parameterOrder": [

- "name"

- ],

- "parameters": {

- "name": {

- "description": "Required. The name of the requested database. Values are of the form\n`projects/<project>/instances/<instance>/databases/<database>`.",

- "location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",

- "required": true,

- "type": "string"

- }

- },

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

- "response": {

- "$ref": "Database"

- },

- "scopes": [

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

- ]

- },

- "dropDatabase": {

- "description": "Drops (aka deletes) a Cloud Spanner database.",

- "httpMethod": "DELETE",

- "id": "spanner.projects.instances.databases.dropDatabase",

- "parameterOrder": [

- "database"

- ],

- "parameters": {

- "database": {

- "description": "Required. The database to be dropped.",

- "location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",

- "required": true,

- "type": "string"

- }

- },

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

- "response": {

- "$ref": "Empty"

- },

- "scopes": [

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

- ]

}

"resources": {

"operations": {

"methods": {

- "cancel": {

- "description": "Starts asynchronous cancellation 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\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\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`.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.databases.operations.cancel",

- "parameterOrder": [

- "name"

- ],

- "parameters": {

- "name": {

- "description": "The name of the operation resource to be cancelled.",

- "location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",

- "required": true,

- "type": "string"

- }

- },

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

- "response": {

- "$ref": "Empty"

- },

- "scopes": [

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

- ]

- },

- "delete": {

- "description": "Deletes a long-running 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 support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",

- "httpMethod": "DELETE",

- "id": "spanner.projects.instances.databases.operations.delete",

- "parameterOrder": [

- "name"

- ],

- "parameters": {

- "name": {

- "description": "The name of the operation resource to be deleted.",

- "location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",

- "required": true,

- "type": "string"

- }

- },

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

- "response": {

- "$ref": "Empty"

- },

- "scopes": [

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

- ]

- },

"list": {

"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 services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",

"httpMethod": "GET",

@@ -765,162 +654,156 @@

"scopes": [

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

]

- }

- },

- "sessions": {

- "methods": {

- "executeSql": {

- "description": "Executes an SQL query, 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 query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",

+ },

+ "cancel": {

+ "description": "Starts asynchronous cancellation 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\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\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`.",

"httpMethod": "POST",

- "id": "spanner.projects.instances.databases.sessions.executeSql",

+ "id": "spanner.projects.instances.databases.operations.cancel",

"parameterOrder": [

- "session"

+ "name"

"parameters": {

- "session": {

- "description": "Required. The session in which the SQL query should be performed.",

+ "name": {

+ "description": "The name of the operation resource to be cancelled.",

"location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+session}:executeSql",

- "request": {

- "$ref": "ExecuteSqlRequest"

- },

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

"response": {

- "$ref": "ResultSet"

+ "$ref": "Empty"

"scopes": [

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

]

- "rollback": {

- "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.databases.sessions.rollback",

+ "delete": {

+ "description": "Deletes a long-running 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 support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",

+ "httpMethod": "DELETE",

+ "id": "spanner.projects.instances.databases.operations.delete",

"parameterOrder": [

- "session"

+ "name"

"parameters": {

- "session": {

- "description": "Required. The session in which the transaction to roll back is running.",

+ "name": {

+ "description": "The name of the operation resource to be deleted.",

"location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+session}:rollback",

- "request": {

- "$ref": "RollbackRequest"

- },

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

"response": {

"$ref": "Empty"

"scopes": [

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

]

- },

- "streamingRead": {

- "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.databases.sessions.streamingRead",

+ }

+ },

+ "sessions": {

+ "methods": {

+ "get": {

+ "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive.",

+ "httpMethod": "GET",

+ "id": "spanner.projects.instances.databases.sessions.get",

"parameterOrder": [

- "session"

+ "name"

"parameters": {

- "session": {

- "description": "Required. The session in which the read should be performed.",

+ "name": {

+ "description": "Required. The name of the session to retrieve.",

"location": "path",

"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+session}:streamingRead",

- "request": {

- "$ref": "ReadRequest"

- },

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

"response": {

- "$ref": "PartialResultSet"

+ "$ref": "Session"

"scopes": [

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

]

- "create": {

- "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and 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 idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete 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\"`.",

+ "executeStreamingSql": {

+ "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on 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.",

"httpMethod": "POST",

- "id": "spanner.projects.instances.databases.sessions.create",

+ "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",

"parameterOrder": [

- "database"

+ "session"

"parameters": {

- "database": {

- "description": "Required. The database in which the new session is created.",

+ "session": {

+ "description": "Required. The session in which the SQL query should be performed.",

"location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",

+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+database}/sessions",

+ "path": "v1/{+session}:executeStreamingSql",

+ "request": {

+ "$ref": "ExecuteSqlRequest"

+ },

"response": {

- "$ref": "Session"

+ "$ref": "PartialResultSet"

"scopes": [

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

]

- "read": {

- "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative to\nExecuteSql. This method cannot be used to\nreturn a result set larger than 10 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_PRECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.",

- "httpMethod": "POST",

- "id": "spanner.projects.instances.databases.sessions.read",

+ "delete": {

+ "description": "Ends a session, releasing server resources associated with it.",

+ "httpMethod": "DELETE",

+ "id": "spanner.projects.instances.databases.sessions.delete",

"parameterOrder": [

- "session"

+ "name"

"parameters": {

- "session": {

- "description": "Required. The session in which the read should be performed.",

+ "name": {

+ "description": "Required. The name of the session to delete.",

"location": "path",

"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+session}:read",

- "request": {

- "$ref": "ReadRequest"

- },

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

"response": {

- "$ref": "ResultSet"

+ "$ref": "Empty"

"scopes": [

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

]

- "get": {

- "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive.",

- "httpMethod": "GET",

- "id": "spanner.projects.instances.databases.sessions.get",

+ "beginTransaction": {

+ "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.databases.sessions.beginTransaction",

"parameterOrder": [

- "name"

+ "session"

"parameters": {

- "name": {

- "description": "Required. The name of the session to retrieve.",

+ "session": {

+ "description": "Required. The session in which the transaction runs.",

"location": "path",

"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

"required": true,

"type": "string"

}

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

+ "path": "v1/{+session}:beginTransaction",

+ "request": {

+ "$ref": "BeginTransactionRequest"

+ },

"response": {

- "$ref": "Session"

+ "$ref": "Transaction"

"scopes": [

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

@@ -953,124 +836,194 @@

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

]

- "beginTransaction": {

- "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",

+ "executeSql": {

+ "description": "Executes an SQL query, 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 query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",

"httpMethod": "POST",

- "id": "spanner.projects.instances.databases.sessions.beginTransaction",

+ "id": "spanner.projects.instances.databases.sessions.executeSql",

"parameterOrder": [

"session"

"parameters": {

"session": {

- "description": "Required. The session in which the transaction runs.",

+ "description": "Required. The session in which the SQL query should be performed.",

"location": "path",

"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+session}:beginTransaction",

+ "path": "v1/{+session}:executeSql",

"request": {

- "$ref": "BeginTransactionRequest"

+ "$ref": "ExecuteSqlRequest"

"response": {

- "$ref": "Transaction"

+ "$ref": "ResultSet"

"scopes": [

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

]

- "executeStreamingSql": {

- "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on 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.",

+ "rollback": {

+ "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`.",

"httpMethod": "POST",

- "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",

+ "id": "spanner.projects.instances.databases.sessions.rollback",

"parameterOrder": [

"session"

"parameters": {

"session": {

- "description": "Required. The session in which the SQL query should be performed.",

+ "description": "Required. The session in which the transaction to roll back is running.",

"location": "path",

"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+session}:executeStreamingSql",

+ "path": "v1/{+session}:rollback",

"request": {

- "$ref": "ExecuteSqlRequest"

+ "$ref": "RollbackRequest"

"response": {

- "$ref": "PartialResultSet"

+ "$ref": "Empty"

"scopes": [

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

]

- "delete": {

- "description": "Ends a session, releasing server resources associated with it.",

- "httpMethod": "DELETE",

- "id": "spanner.projects.instances.databases.sessions.delete",

+ "streamingRead": {

+ "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.databases.sessions.streamingRead",

"parameterOrder": [

- "name"

+ "session"

"parameters": {

- "name": {

- "description": "Required. The name of the session to delete.",

+ "session": {

+ "description": "Required. The session in which the read should be performed.",

"location": "path",

"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

"required": true,

"type": "string"

}

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

+ "path": "v1/{+session}:streamingRead",

+ "request": {

+ "$ref": "ReadRequest"

+ },

"response": {

- "$ref": "Empty"

+ "$ref": "PartialResultSet"

"scopes": [

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

]

- }

- },

+ },

+ "create": {

+ "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and 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 idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session 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\"`.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.databases.sessions.create",

+ "parameterOrder": [

+ "database"

+ ],

+ "parameters": {

+ "database": {

+ "description": "Required. The database in which the new session is created.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

+ "path": "v1/{+database}/sessions",

+ "response": {

+ "$ref": "Session"

+ },

+ "scopes": [

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

+ ]

+ },

+ "read": {

+ "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative to\nExecuteSql. This method cannot be used to\nreturn a result set larger than 10 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_PRECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.",

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.databases.sessions.read",

+ "parameterOrder": [

+ "session"

+ ],

+ "parameters": {

+ "session": {

+ "description": "Required. The session in which the read should be performed.",

+ "location": "path",

+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",

+ "required": true,

+ "type": "string"

+ }

+ },

+ "path": "v1/{+session}:read",

+ "request": {

+ "$ref": "ReadRequest"

+ },

+ "response": {

+ "$ref": "ResultSet"

+ },

+ "scopes": [

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

+ ]

+ }

+ },

"operations": {

"methods": {

- "cancel": {

- "httpMethod": "POST",

- "id": "spanner.projects.instances.operations.cancel",

+ "list": {

+ "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 services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",

+ "httpMethod": "GET",

+ "id": "spanner.projects.instances.operations.list",

"parameterOrder": [

"name"

"parameters": {

+ "filter": {

+ "description": "The standard list filter.",

+ "location": "query",

+ "type": "string"

+ },

"name": {

- "description": "The name of the operation resource to be cancelled.",

+ "description": "The name of the operation collection.",

"location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",

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

"required": true,

"type": "string"

+ },

+ "pageToken": {

+ "description": "The standard list page token.",

+ "location": "query",

+ "type": "string"

+ },

+ "pageSize": {

+ "description": "The standard list page size.",

+ "format": "int32",

+ "location": "query",

+ "type": "integer"

}

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

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

"response": {

- "$ref": "Empty"

+ "$ref": "ListOperationsResponse"

"scopes": [

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

]

- "delete": {

- "httpMethod": "DELETE",

- "id": "spanner.projects.instances.operations.delete",

+ "get": {

+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",

+ "httpMethod": "GET",

+ "id": "spanner.projects.instances.operations.get",

"parameterOrder": [

"name"

"parameters": {

"name": {

- "description": "The name of the operation resource to be deleted.",

+ "description": "The name of the operation resource.",

"location": "path",

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

"required": true,

@@ -1079,62 +1032,46 @@

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

"response": {

- "$ref": "Empty"

+ "$ref": "Operation"

"scopes": [

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

]

- "list": {

- "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 services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",

- "httpMethod": "GET",

- "id": "spanner.projects.instances.operations.list",

+ "cancel": {

+ "httpMethod": "POST",

+ "id": "spanner.projects.instances.operations.cancel",

"parameterOrder": [

"name"

"parameters": {

"name": {

- "description": "The name of the operation collection.",

+ "description": "The name of the operation resource to be cancelled.",

"location": "path",

- "pattern": "^projects/[^/]+/instances/[^/]+/operations$",

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

"required": true,

"type": "string"

- },

- "pageToken": {

- "description": "The standard list page token.",

- "location": "query",

- "type": "string"

- },

- "pageSize": {

- "description": "The standard list page size.",

- "format": "int32",

- "location": "query",

- "type": "integer"

- },

- "filter": {

- "description": "The standard list filter.",

- "location": "query",

- "type": "string"

}

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

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

"response": {

- "$ref": "ListOperationsResponse"

+ "$ref": "Empty"

"scopes": [

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

]

- "get": {

- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",

- "httpMethod": "GET",

- "id": "spanner.projects.instances.operations.get",

+ "delete": {

+ "httpMethod": "DELETE",

+ "id": "spanner.projects.instances.operations.delete",

"parameterOrder": [

"name"

"parameters": {

"name": {

- "description": "The name of the operation resource.",

+ "description": "The name of the operation resource to be deleted.",

"location": "path",

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

"required": true,

@@ -1143,7 +1080,7 @@

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

"response": {

- "$ref": "Operation"

+ "$ref": "Empty"

"scopes": [

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

@@ -1152,582 +1089,240 @@

}

+ },

+ "instanceConfigs": {

+ "methods": {

+ "list": {

+ "description": "Lists the supported instance configurations for a given project.",

+ "httpMethod": "GET",

+ "id": "spanner.projects.instanceConfigs.list",

+ "parameterOrder": [

+ "parent"

+ ],

+ "parameters": {

+ "pageSize": {

+ "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",

+ "format": "int32",

+ "location": "query",

+ "type": "integer"

+ },

+ "parent": {

+ "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/<project>`.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ },

+ "pageToken": {

+ "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",

+ "location": "query",

+ "type": "string"

+ }

+ },

+ "path": "v1/{+parent}/instanceConfigs",

+ "response": {

+ "$ref": "ListInstanceConfigsResponse"

+ },

+ "scopes": [

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

+ ]

+ },

+ "get": {

+ "description": "Gets information about a particular instance configuration.",

+ "httpMethod": "GET",

+ "id": "spanner.projects.instanceConfigs.get",

+ "parameterOrder": [

+ "name"

+ ],

+ "parameters": {

+ "name": {

+ "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/<project>/instanceConfigs/<config>`.",

+ "location": "path",

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

+ "required": true,

+ "type": "string"

+ }

+ },

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

+ "response": {

+ "$ref": "InstanceConfig"

+ },

+ "scopes": [

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

+ ]

+ }

}

- "revision": "20170214",

+ "revision": "20170317",

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

"schemas": {

- "ResultSetStats": {

- "description": "Additional statistics about a ResultSet or PartialResultSet.",

- "id": "ResultSetStats",

+ "Session": {

+ "description": "A session in the Cloud Spanner API.",

+ "id": "Session",

"properties": {

- "queryStats": {

- "additionalProperties": {

- "description": "Properties of the object.",

- "type": "any"

- },

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

- "type": "object"

- },

- "queryPlan": {

- "$ref": "QueryPlan",

- "description": "QueryPlan for the query associated with this result."

+ "name": {

+ "description": "Required. The name of the session.",

+ "type": "string"

}

"type": "object"

- "TestIamPermissionsRequest": {

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

- "id": "TestIamPermissionsRequest",

+ "ListInstancesResponse": {

+ "description": "The response for ListInstances.",

+ "id": "ListInstancesResponse",

"properties": {

- "permissions": {

- "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",

+ "nextPageToken": {

+ "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",

+ "type": "string"

+ },

+ "instances": {

+ "description": "The list of requested instances.",

"items": {

- "type": "string"

+ "$ref": "Instance"

"type": "array"

}

"type": "object"

- "CommitResponse": {

- "description": "The response for Commit.",

- "id": "CommitResponse",

+ "KeyRange": {

+ "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, 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 the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY 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` clause 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 components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, 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, the following range includes all events for `\"Bob\"` that\noccurred during and after 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 events 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_closed\": [\"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\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\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.",

+ "id": "KeyRange",

"properties": {

- "commitTimestamp": {

- "description": "The Cloud Spanner timestamp at which the transaction committed.",

- "format": "google-datetime",

- "type": "string"

- }

- },

- "type": "object"

- },

- "Type": {

- "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",

- "id": "Type",

- "properties": {

- "arrayElementType": {

- "$ref": "Type",

- "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."

- },

- "code": {

- "description": "Required. The TypeCode for this type.",

- "enum": [

- "TYPE_CODE_UNSPECIFIED",

- "BOOL",

- "INT64",

- "FLOAT64",

- "TIMESTAMP",

- "DATE",

- "STRING",

- "BYTES",

- "ARRAY",

- "STRUCT"

- ],

- "enumDescriptions": [

- "Not specified.",

- "Encoded as JSON `true` or `false`.",

- "Encoded as `string`, in decimal format.",

- "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",

- "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",

- "Encoded as `string` in RFC 3339 date format.",

- "Encoded as `string`.",

- "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",

- "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",

- "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."

- ],

- "type": "string"

- },

- "structType": {

- "$ref": "StructType",

- "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."

- }

- },

- "type": "object"

- },

- "PlanNode": {

- "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",

- "id": "PlanNode",

- "properties": {

- "metadata": {

- "additionalProperties": {

- "description": "Properties of the object.",

+ "endOpen": {

+ "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",

+ "items": {

"type": "any"

- "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_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",

- "type": "object"

+ "type": "array"

- "executionStats": {

- "additionalProperties": {

- "description": "Properties of the object.",

+ "endClosed": {

+ "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",

+ "items": {

"type": "any"

- "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.",

- "type": "object"

- },

- "shortRepresentation": {

- "$ref": "ShortRepresentation",

- "description": "Condensed representation for SCALAR nodes."

- },

- "index": {

- "description": "The `PlanNode`'s index in node list.",

- "format": "int32",

- "type": "integer"

- },

- "kind": {

- "description": "Used to determine the type of node. May be needed 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 used to directly embed a description of the node in its\nparent.",

- "enum": [

- "KIND_UNSPECIFIED",

- "RELATIONAL",

- "SCALAR"

- ],

- "enumDescriptions": [

- "Not specified.",

- "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.",

- "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names."

- ],

- "type": "string"

+ "type": "array"

- "displayName": {

- "description": "The display name for the node.",

- "type": "string"

+ "startClosed": {

+ "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.",

+ "items": {

+ "type": "any"

+ },

+ "type": "array"

- "childLinks": {

- "description": "List of child node `index`es and their relationship to this parent.",

+ "startOpen": {

+ "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",

"items": {

- "$ref": "ChildLink"

+ "type": "any"

"type": "array"

}

"type": "object"

- "AuditConfig": {

- "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.",

- "id": "AuditConfig",

+ "ShortRepresentation": {

+ "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",

+ "id": "ShortRepresentation",

"properties": {

- "exemptedMembers": {

- "description": "Specifies the identities that are exempted from \"data access\" audit\nlogging for the `service` specified above.\nFollows the same format of Binding.members.\nThis field is deprecated in favor of per-permission-type exemptions.",

- "items": {

- "type": "string"

- },

- "type": "array"

- },

- "service": {

- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",

+ "description": {

+ "description": "A string representation of the expression subtree rooted at this node.",

"type": "string"

- "auditLogConfigs": {

- "description": "The configuration for logging of each type of permission.\nNext ID: 4",

- "items": {

- "$ref": "AuditLogConfig"

+ "subqueries": {

+ "additionalProperties": {

+ "format": "int32",

+ "type": "integer"

- "type": "array"

+ "description": "A mapping of (subquery variable name) -> (subquery node id) for cases\nwhere the `description` string of this node references 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.",

+ "type": "object"

}

"type": "object"

- "CreateInstanceMetadata": {

- "description": "Metadata type for the operation returned by\nCreateInstance.",

- "id": "CreateInstanceMetadata",

+ "InstanceConfig": {

+ "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",

+ "id": "InstanceConfig",

"properties": {

- "instance": {

- "$ref": "Instance",

- "description": "The instance being created."

- },

- "startTime": {

- "description": "The time at which the\nCreateInstance request was\nreceived.",

- "format": "google-datetime",

- "type": "string"

- },

- "cancelTime": {

- "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",

- "format": "google-datetime",

+ "displayName": {

+ "description": "The name of this instance configuration as it appears in UIs.",

"type": "string"

- "endTime": {

- "description": "The time at which this operation failed or was completed successfully.",

- "format": "google-datetime",

+ "name": {

+ "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/<project>/instanceConfigs/a-z*`",

"type": "string"

}

"type": "object"

- "ChildLink": {

- "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",

- "id": "ChildLink",

+ "UpdateInstanceRequest": {

+ "description": "The request for UpdateInstance.",

+ "id": "UpdateInstanceRequest",

"properties": {

- "childIndex": {

- "description": "The node to which the link points.",

- "format": "int32",

- "type": "integer"

- },

- "variable": {

- "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name 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 output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.",

- "type": "string"

+ "instance": {

+ "$ref": "Instance",

+ "description": "Required. The instance to update, which must always include the instance\nname. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included."

- "type": {

- "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",

+ "fieldMask": {

+ "description": "Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.\nThe field mask must always be specified; this prevents any future fields in\n[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know\nabout them.",

+ "format": "google-fieldmask",

"type": "string"

}

"type": "object"

- "CloudAuditOptions": {

- "description": "Write a Cloud Audit log",

- "id": "CloudAuditOptions",

+ "Empty": {

+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",

+ "id": "Empty",

"properties": {},

"type": "object"

- "Delete": {

- "description": "Arguments to delete operations.",

- "id": "Delete",

+ "TransactionOptions": {

+ "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp <=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n<= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.",

+ "id": "TransactionOptions",

"properties": {

- "table": {

- "description": "Required. The table whose rows will be deleted.",

- "type": "string"

+ "readWrite": {

+ "$ref": "ReadWrite",

+ "description": "Transaction may write.\n\nAuthorization to begin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWriteTransaction` permission\non the `session` resource."

- "keySet": {

- "$ref": "KeySet",

- "description": "Required. The primary keys of the rows within table to delete."

- }

- },

- "type": "object"

- },

- "BeginTransactionRequest": {

- "description": "The request for BeginTransaction.",

- "id": "BeginTransactionRequest",

- "properties": {

- "options": {

- "$ref": "TransactionOptions",

- "description": "Required. Options for the new transaction."

+ "readOnly": {

+ "$ref": "ReadOnly",

+ "description": "Transaction will not write.\n\nAuthorization to begin a read-only transaction requires\n`spanner.databases.beginReadOnlyTransaction` permission\non the `session` resource."

}

"type": "object"

- "CommitRequest": {

- "description": "The request for Commit.",

- "id": "CommitRequest",

+ "CreateDatabaseRequest": {

+ "description": "The request for CreateDatabase.",

+ "id": "CreateDatabaseRequest",

"properties": {

- "singleUseTransaction": {

- "$ref": "TransactionOptions",

- "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary 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 application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead."

+ "createStatement": {

+ "description": "Required. A `CREATE DATABASE` statement, which specifies the ID of the\nnew database. The database ID must conform to the regular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.",

+ "type": "string"

- "mutations": {

- "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",

+ "extraStatements": {

+ "description": "An optional list of DDL statements to run inside the newly created\ndatabase. Statements can create tables, indexes, etc. These\nstatements execute atomically with the creation of the database:\nif there is an error in any statement, the database is not created.",

"items": {

- "$ref": "Mutation"

+ "type": "string"

"type": "array"

- },

- "transactionId": {

- "description": "Commit a previously-started transaction.",

- "format": "byte",

- "type": "string"

}

"type": "object"

- "ListInstanceConfigsResponse": {

- "description": "The response for ListInstanceConfigs.",

- "id": "ListInstanceConfigsResponse",

+ "CreateInstanceRequest": {

+ "description": "The request for CreateInstance.",

+ "id": "CreateInstanceRequest",

"properties": {

- "nextPageToken": {

- "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",

+ "instanceId": {

+ "description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",

"type": "string"

- "instanceConfigs": {

- "description": "The list of requested instance configurations.",

- "items": {

- "$ref": "InstanceConfig"

- },

- "type": "array"

- }

- },

- "type": "object"

- },

- "TestIamPermissionsResponse": {

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

- "id": "TestIamPermissionsResponse",

- "properties": {

- "permissions": {

- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",

- "items": {

- "type": "string"

- },

- "type": "array"

- }

- },

- "type": "object"

- },

- "GetIamPolicyRequest": {

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

- "id": "GetIamPolicyRequest",

- "properties": {},

- "type": "object"

- },

- "Rule": {

- "description": "A rule to be applied in a Policy.",

- "id": "Rule",

- "properties": {

- "in": {

- "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",

- "items": {

- "type": "string"

- },

- "type": "array"

- },

- "permissions": {

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

- "items": {

- "type": "string"

- },

- "type": "array"

- },

- "action": {

- "description": "Required",

- "enum": [

- "NO_ACTION",

- "ALLOW",

- "ALLOW_WITH_LOG",

- "DENY",

- "DENY_WITH_LOG",

- "LOG"

- ],

- "enumDescriptions": [

- "Default no action.",

- "Matching 'Entries' grant access.",

- "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",

- "Matching 'Entries' deny access.",

- "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",

- "Matching 'Entries' tell IAM.Check callers to generate logs."

- ],

- "type": "string"

- },

- "notIn": {

- "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",

- "items": {

- "type": "string"

- },

- "type": "array"

- },

- "description": {

- "description": "Human-readable description of the rule.",

- "type": "string"

- },

- "conditions": {

- "description": "Additional restrictions that must be met",

- "items": {

- "$ref": "Condition"

- },

- "type": "array"

- },

- "logConfig": {

- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",

- "items": {

- "$ref": "LogConfig"

- },

- "type": "array"

- }

- },

- "type": "object"

- },

- "CreateDatabaseMetadata": {

- "description": "Metadata type for the operation returned by\nCreateDatabase.",

- "id": "CreateDatabaseMetadata",

- "properties": {

- "database": {

- "description": "The database being created.",

- "type": "string"

- }

- },

- "type": "object"

- },

- "LogConfig": {

- "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names 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 request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",

- "id": "LogConfig",

- "properties": {

- "dataAccess": {

- "$ref": "DataAccessOptions",

- "description": "Data access options."

- },

- "cloudAudit": {

- "$ref": "CloudAuditOptions",

- "description": "Cloud audit options."

- },

- "counter": {

- "$ref": "CounterOptions",

- "description": "Counter options."

- }

- },

- "type": "object"

- },

- "Session": {

- "description": "A session in the Cloud Spanner API.",

- "id": "Session",

- "properties": {

- "name": {

- "description": "Required. The name of the session.",

- "type": "string"

- }

- },

- "type": "object"

- },

- "KeyRange": {

- "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, 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 the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY 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` clause 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 components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, 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, the following range includes all events for `\"Bob\"` that\noccurred during and after 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 events 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_closed\": [\"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\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\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.",

- "id": "KeyRange",

- "properties": {

- "startClosed": {

- "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.",

- "items": {

- "type": "any"

- },

- "type": "array"

- },

- "startOpen": {

- "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",

- "items": {

- "type": "any"

- },

- "type": "array"

- },

- "endOpen": {

- "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",

- "items": {

- "type": "any"

- },

- "type": "array"

- },

- "endClosed": {

- "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",

- "items": {

- "type": "any"

- },

- "type": "array"

- }

- },

- "type": "object"

- },

- "ListInstancesResponse": {

- "description": "The response for ListInstances.",

- "id": "ListInstancesResponse",

- "properties": {

- "nextPageToken": {

- "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",

- "type": "string"

- },

- "instances": {

- "description": "The list of requested instances.",

- "items": {

- "$ref": "Instance"

- },

- "type": "array"

- }

- },

- "type": "object"

- },

- "ShortRepresentation": {

- "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",

- "id": "ShortRepresentation",

- "properties": {

- "description": {

- "description": "A string representation of the expression subtree rooted at this node.",

- "type": "string"

- },

- "subqueries": {

- "additionalProperties": {

- "format": "int32",

- "type": "integer"

- },

- "description": "A mapping of (subquery variable name) -> (subquery node id) for cases\nwhere the `description` string of this node references 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.",

- "type": "object"

- }

- },

- "type": "object"

- },

- "InstanceConfig": {

- "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",

- "id": "InstanceConfig",

- "properties": {

- "name": {

- "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/<project>/instanceConfigs/a-z*`",

- "type": "string"

- },

- "displayName": {

- "description": "The name of this instance configuration as it appears in UIs.",

- "type": "string"

- }

- },

- "type": "object"

- },

- "UpdateInstanceRequest": {

- "description": "The request for UpdateInstance.",

- "id": "UpdateInstanceRequest",

- "properties": {

- "instance": {

- "$ref": "Instance",

- "description": "Required. The instance to update, which must always include the instance\nname. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included."

- },

- "fieldMask": {

- "description": "Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.\nThe field mask must always be specified; this prevents any future fields in\n[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know\nabout them.",

- "format": "google-fieldmask",

- "type": "string"

- }

- },

- "type": "object"

- },

- "Empty": {

- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",

- "id": "Empty",

- "properties": {},

- "type": "object"

- },

- "TransactionOptions": {

- "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp <=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n<= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.",

- "id": "TransactionOptions",

- "properties": {

- "readWrite": {

- "$ref": "ReadWrite",

- "description": "Transaction may write.\n\nAuthorization to begin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWriteTransaction` permission\non the `session` resource."

- },

- "readOnly": {

- "$ref": "ReadOnly",

- "description": "Transaction will not write.\n\nAuthorization to begin a read-only transaction requires\n`spanner.databases.beginReadOnlyTransaction` permission\non the `session` resource."

- }

- },

- "type": "object"

- },

- "CreateDatabaseRequest": {

- "description": "The request for CreateDatabase.",

- "id": "CreateDatabaseRequest",

- "properties": {

- "createStatement": {

- "description": "Required. A `CREATE DATABASE` statement, which specifies the ID of the\nnew database. The database ID must conform to the regular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.",

- "type": "string"

- },

- "extraStatements": {

- "description": "An optional list of DDL statements to run inside the newly created\ndatabase. Statements can create tables, indexes, etc. These\nstatements execute atomically with the creation of the database:\nif there is an error in any statement, the database is not created.",

- "items": {

- "type": "string"

- },

- "type": "array"

- }

- },

- "type": "object"

- },

- "CreateInstanceRequest": {

- "description": "The request for CreateInstance.",

- "id": "CreateInstanceRequest",

- "properties": {

- "instanceId": {

- "description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",

- "type": "string"

- },

- "instance": {

- "$ref": "Instance",

- "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `<parent>/instances/<instance_id>`."

+ "instance": {

+ "$ref": "Instance",

+ "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `<parent>/instances/<instance_id>`."

}

"type": "object"

@@ -1758,29 +1353,31 @@

"type": "string"

- "values": {

- "description": "The objects of the condition. This is mutually exclusive with 'value'.",

- "items": {

- "type": "string"

- },

- "type": "array"

- },

"iam": {

"description": "Trusted attributes supplied by the IAM system.",

"enum": [

"NO_ATTR",

"AUTHORITY",

"ATTRIBUTION",

- "SECURITY_REALM"

+ "SECURITY_REALM",

+ "APPROVER"

"enumDescriptions": [

"Default non-attribute.",

"Either principal or (if present) authority selector.",

"The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",

- "Any of the security realms in the IAMContext (go/security-realms).\nWhen used with IN, the condition indicates \"any of the request's realms\nmatch one of the given values; with NOT_IN, \"none of the realms match\nany of the given values\". It is not permitted to grant access based on\nthe *absence* of a realm, so realm conditions can only be used in\na \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN)."

+ "Any of the security realms in the IAMContext (go/security-realms).\nWhen used with IN, the condition indicates \"any of the request's realms\nmatch one of the given values; with NOT_IN, \"none of the realms match\nany of the given values\". It is not permitted to grant access based on\nthe *absence* of a realm, so realm conditions can only be used in\na \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).",

+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth."

"type": "string"

+ "values": {

+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",

+ "items": {

+ "type": "string"

+ },

+ "type": "array"

+ },

"op": {

"description": "An operator to apply the subject with.",

"enum": [

@@ -1842,8 +1439,12 @@

"description": "Options for read-only transactions.",

"id": "ReadOnly",

"properties": {

- "readTimestamp": {

- "description": "Executes all reads at the given timestamp. Unlike 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 deadline.\n\nUseful for large scale consistent reads such as mapreduces, or\nfor coordinating many reads against a consistent snapshot of the\ndata.",

+ "strong": {

+ "description": "Read at a timestamp where all previously committed transactions\nare visible.",

+ "type": "boolean"

+ },

+ "minReadTimestamp": {

+ "description": "Executes all reads at a timestamp >= `min_read_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 committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.",

"format": "google-datetime",

"type": "string"

@@ -1852,6 +1453,11 @@

"format": "google-duration",

"type": "string"

+ "readTimestamp": {

+ "description": "Executes all reads at the given timestamp. Unlike 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 deadline.\n\nUseful for large scale consistent reads such as mapreduces, or\nfor coordinating many reads against a consistent snapshot of the\ndata.",

+ "format": "google-datetime",

+ "type": "string"

+ },

"returnReadTimestamp": {

"description": "If true, the Cloud Spanner-selected read timestamp is included in\nthe Transaction message that describes the transaction.",

"type": "boolean"

@@ -1860,15 +1466,6 @@

"description": "Executes all reads at a timestamp that is `exact_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 Cloud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas without the distributed\ntimestamp negotiation overhead of `max_staleness`.",

"format": "google-duration",

"type": "string"

- },

- "strong": {

- "description": "Read at a timestamp where all previously committed transactions\nare visible.",

- "type": "boolean"

- },

- "minReadTimestamp": {

- "description": "Executes all reads at a timestamp >= `min_read_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 committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.",

- "format": "google-datetime",

- "type": "string"

}

"type": "object"

@@ -1877,29 +1474,6 @@

"description": "The request for ExecuteSql and\nExecuteStreamingSql.",

"id": "ExecuteSqlRequest",

"properties": {

- "queryMode": {

- "description": "Used to control the amount of debugging information returned in\nResultSetStats.",

- "enum": [

- "NORMAL",

- "PLAN",

- "PROFILE"

- ],

- "enumDescriptions": [

- "The default mode where only the query result, without any information\nabout the query plan is returned.",

- "This mode returns only the query plan, without any result rows or\nexecution statistics information.",

- "This mode returns both the query plan and the execution statistics along\nwith the result rows."

- ],

- "type": "string"

- },

- "transaction": {

- "$ref": "TransactionSelector",

- "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."

- },

- "resumeToken": {

- "description": "If this request is resuming a previously interrupted SQL query\nexecution, `resume_token` should be copied from the last\nPartialResultSet 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.",

- "format": "byte",

- "type": "string"

- },

"paramTypes": {

"additionalProperties": {

"$ref": "Type"

@@ -1918,6 +1492,29 @@

"description": "The SQL query string can contain parameter placeholders. A parameter\nplaceholder consists of `'@'` followed by the parameter\nname. Parameter names consist of any combination of letters,\nnumbers, and underscores.\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 with unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorresponding parameter values.",

"type": "object"

+ },

+ "queryMode": {

+ "description": "Used to control the amount of debugging information returned in\nResultSetStats.",

+ "enum": [

+ "NORMAL",

+ "PLAN",

+ "PROFILE"

+ ],

+ "enumDescriptions": [

+ "The default mode where only the query result, without any information\nabout the query plan is returned.",

+ "This mode returns only the query plan, without any result rows or\nexecution statistics information.",

+ "This mode returns both the query plan and the execution statistics along\nwith the result rows."

+ ],

+ "type": "string"

+ },

+ "transaction": {

+ "$ref": "TransactionSelector",

+ "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."

+ },

+ "resumeToken": {

+ "description": "If this request is resuming a previously interrupted SQL query\nexecution, `resume_token` should be copied from the last\nPartialResultSet 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.",

+ "format": "byte",

+ "type": "string"

}

"type": "object"

@@ -2007,10 +1604,6 @@

"description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",

"id": "Write",

"properties": {

- "table": {

- "description": "Required. The table whose rows will be written.",

- "type": "string"

- },

"columns": {

"description": "The names of the columns in table to be written.\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.",

"items": {

@@ -2027,6 +1620,10 @@

"type": "array"

+ },

+ "table": {

+ "description": "Required. The table whose rows will be written.",

+ "type": "string"

}

"type": "object"

@@ -2245,13 +1842,13 @@

"description": "Metadata about a ResultSet or PartialResultSet.",

"id": "ResultSetMetadata",

"properties": {

- "rowType": {

- "$ref": "StructType",

- "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName 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 ]"

- },

"transaction": {

"$ref": "Transaction",

"description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here."

+ },

+ "rowType": {

+ "$ref": "StructType",

+ "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName 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 ]"

}

"type": "object"

@@ -2268,75 +1865,325 @@

"$ref": "TransactionOptions",

"description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction."

- "id": {

- "description": "Execute the read or SQL query in a previously-started transaction.",

- "format": "byte",

+ "id": {

+ "description": "Execute the read or SQL query in a previously-started transaction.",

+ "format": "byte",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "KeySet": {

+ "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 specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",

+ "id": "KeySet",

+ "properties": {

+ "ranges": {

+ "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",

+ "items": {

+ "$ref": "KeyRange"

+ },

+ "type": "array"

+ },

+ "keys": {

+ "description": "A list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.",

+ "items": {

+ "type": "any"

+ },

+ "type": "array"

+ },

+ "type": "array"

+ },

+ "all": {

+ "description": "For convenience `all` can be set to `true` to 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.",

+ "type": "boolean"

+ }

+ },

+ "type": "object"

+ },

+ "Mutation": {

+ "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.",

+ "id": "Mutation",

+ "properties": {

+ "insert": {

+ "$ref": "Write",

+ "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."

+ },

+ "insertOrUpdate": {

+ "$ref": "Write",

+ "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved."

+ },

+ "update": {

+ "$ref": "Write",

+ "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."

+ },

+ "replace": {

+ "$ref": "Write",

+ "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`."

+ },

+ "delete": {

+ "$ref": "Delete",

+ "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."

+ }

+ },

+ "type": "object"

+ },

+ "GetDatabaseDdlResponse": {

+ "description": "The response for GetDatabaseDdl.",

+ "id": "GetDatabaseDdlResponse",

+ "properties": {

+ "statements": {

+ "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",

+ "items": {

+ "type": "string"

+ },

+ "type": "array"

+ }

+ },

+ "type": "object"

+ },

+ "Database": {

+ "description": "A Cloud Spanner database.",

+ "id": "Database",

+ "properties": {

+ "state": {

+ "description": "Output only. The current database state.",

+ "enum": [

+ "STATE_UNSPECIFIED",

+ "CREATING",

+ "READY"

+ ],

+ "enumDescriptions": [

+ "Not specified.",

+ "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.",

+ "The database is fully created and ready for use."

+ ],

+ "type": "string"

+ },

+ "name": {

+ "description": "Required. The name of the database. Values are of the form\n`projects/<project>/instances/<instance>/databases/<database>`,\nwhere `<database>` is as specified in the `CREATE DATABASE`\nstatement. This name can be passed to other API methods to\nidentify the database.",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "ListDatabasesResponse": {

+ "description": "The response for ListDatabases.",

+ "id": "ListDatabasesResponse",

+ "properties": {

+ "nextPageToken": {

+ "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.",

+ "type": "string"

+ },

+ "databases": {

+ "description": "Databases that matched the request.",

+ "items": {

+ "$ref": "Database"

+ },

+ "type": "array"

+ }

+ },

+ "type": "object"

+ },

+ "SetIamPolicyRequest": {

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

+ "id": "SetIamPolicyRequest",

+ "properties": {

+ "updateMask": {

+ "description": "OPTIONAL: A FieldMask specifying which fields 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 field is only used by Cloud IAM.",

+ "format": "google-fieldmask",

+ "type": "string"

+ },

+ "policy": {

+ "$ref": "Policy",

+ "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 empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."

+ }

+ },

+ "type": "object"

+ },

+ "Instance": {

+ "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",

+ "id": "Instance",

+ "properties": {

+ "labels": {

+ "additionalProperties": {

+ "type": "string"

+ },

+ "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 filter 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 characters 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\nSee 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 + \"_\" + value would prove problematic if we were to\nallow \"_\" in a future release.",

+ "type": "object"

+ },

+ "config": {

+ "description": "Required. The name of the instance's configuration. Values are of the form\n`projects/<project>/instanceConfigs/<configuration>`. See\nalso InstanceConfig and\nListInstanceConfigs.",

+ "type": "string"

+ },

+ "state": {

+ "description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.",

+ "enum": [

+ "STATE_UNSPECIFIED",

+ "CREATING",

+ "READY"

+ ],

+ "enumDescriptions": [

+ "Not specified.",

+ "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",

+ "The instance is fully created and ready to do work such as\ncreating databases."

+ ],

+ "type": "string"

+ },

+ "name": {

+ "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/<project>/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",

+ "type": "string"

+ },

+ "displayName": {

+ "description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.",

+ "type": "string"

+ },

+ "nodeCount": {

+ "description": "Required. The number of nodes allocated to this instance.",

+ "format": "int32",

+ "type": "integer"

+ }

+ },

+ "type": "object"

+ },

+ "RollbackRequest": {

+ "description": "The request for Rollback.",

+ "id": "RollbackRequest",

+ "properties": {

+ "transactionId": {

+ "description": "Required. The transaction to roll back.",

+ "format": "byte",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "Transaction": {

+ "description": "A transaction.",

+ "id": "Transaction",

+ "properties": {

+ "readTimestamp": {

+ "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",

+ "format": "google-datetime",

+ "type": "string"

+ },

+ "id": {

+ "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",

+ "format": "byte",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "UpdateDatabaseDdlMetadata": {

+ "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",

+ "id": "UpdateDatabaseDdlMetadata",

+ "properties": {

+ "statements": {

+ "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.",

+ "items": {

+ "type": "string"

+ },

+ "type": "array"

+ },

+ "commitTimestamps": {

+ "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.",

+ "items": {

+ "format": "google-datetime",

+ "type": "string"

+ },

+ "type": "array"

+ },

+ "database": {

+ "description": "The database being modified.",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "CounterOptions": {

+ "description": "Options for counters",

+ "id": "CounterOptions",

+ "properties": {

+ "metric": {

+ "description": "The metric to update.",

+ "type": "string"

+ },

+ "field": {

+ "description": "The field value to attribute.",

"type": "string"

}

"type": "object"

- "KeySet": {

- "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 specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",

- "id": "KeySet",

+ "QueryPlan": {

+ "description": "Contains an ordered list of nodes appearing in the query plan.",

+ "id": "QueryPlan",

"properties": {

- "keys": {

- "description": "A list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.",

+ "planNodes": {

+ "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresponds to its index in\n`plan_nodes`.",

"items": {

- "items": {

- "type": "any"

- },

- "type": "array"

+ "$ref": "PlanNode"

"type": "array"

- },

- "all": {

- "description": "For convenience `all` can be set to `true` to 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.",

- "type": "boolean"

- },

- "ranges": {

- "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",

+ }

+ },

+ "type": "object"

+ },

+ "StructType": {

+ "description": "`StructType` defines the fields of a STRUCT type.",

+ "id": "StructType",

+ "properties": {

+ "fields": {

+ "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nlists, where the order of field values matches the order of\nfields in the StructType. In turn, the order of fields\nmatches the order of columns in a read request, or the order of\nfields in the `SELECT` clause of a query.",

"items": {

- "$ref": "KeyRange"

+ "$ref": "Field"

"type": "array"

}

"type": "object"

- "Mutation": {

- "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.",

- "id": "Mutation",

+ "Field": {

+ "description": "Message representing a single field of a struct.",

+ "id": "Field",

"properties": {

- "replace": {

- "$ref": "Write",

- "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`."

- },

- "delete": {

- "$ref": "Delete",

- "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."

- },

- "insert": {

- "$ref": "Write",

- "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."

+ "type": {

+ "$ref": "Type",

+ "description": "The type of the field."

- "insertOrUpdate": {

- "$ref": "Write",

- "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved."

+ "name": {

+ "description": "The name of the field. For reads, this is the 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.",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "ResultSetStats": {

+ "description": "Additional statistics about a ResultSet or PartialResultSet.",

+ "id": "ResultSetStats",

+ "properties": {

+ "queryPlan": {

+ "$ref": "QueryPlan",

+ "description": "QueryPlan for the query associated with this result."

- "update": {

- "$ref": "Write",

- "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."

+ "queryStats": {

+ "additionalProperties": {

+ "description": "Properties of the object.",

+ "type": "any"

+ },

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

+ "type": "object"

}

"type": "object"

- "GetDatabaseDdlResponse": {

- "description": "The response for GetDatabaseDdl.",

- "id": "GetDatabaseDdlResponse",

+ "TestIamPermissionsRequest": {

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

+ "id": "TestIamPermissionsRequest",

"properties": {

- "statements": {

- "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",

+ "permissions": {

+ "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",

"items": {

"type": "string"

@@ -2345,158 +2192,275 @@

"type": "object"

- "Database": {

- "description": "A Cloud Spanner database.",

- "id": "Database",

+ "CommitResponse": {

+ "description": "The response for Commit.",

+ "id": "CommitResponse",

"properties": {

- "state": {

- "description": "Output only. The current database state.",

+ "commitTimestamp": {

+ "description": "The Cloud Spanner timestamp at which the transaction committed.",

+ "format": "google-datetime",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "Type": {

+ "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",

+ "id": "Type",

+ "properties": {

+ "arrayElementType": {

+ "$ref": "Type",

+ "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."

+ },

+ "code": {

+ "description": "Required. The TypeCode for this type.",

"enum": [

- "STATE_UNSPECIFIED",

- "CREATING",

- "READY"

+ "TYPE_CODE_UNSPECIFIED",

+ "BOOL",

+ "INT64",

+ "FLOAT64",

+ "TIMESTAMP",

+ "DATE",

+ "STRING",

+ "BYTES",

+ "ARRAY",

+ "STRUCT"

"enumDescriptions": [

"Not specified.",

- "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.",

- "The database is fully created and ready for use."

+ "Encoded as JSON `true` or `false`.",

+ "Encoded as `string`, in decimal format.",

+ "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",

+ "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",

+ "Encoded as `string` in RFC 3339 date format.",

+ "Encoded as `string`.",

+ "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",

+ "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",

+ "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."

"type": "string"

- "name": {

- "description": "Required. The name of the database. Values are of the form\n`projects/<project>/instances/<instance>/databases/<database>`,\nwhere `<database>` is as specified in the `CREATE DATABASE`\nstatement. This name can be passed to other API methods to\nidentify the database.",

- "type": "string"

+ "structType": {

+ "$ref": "StructType",

+ "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."

}

"type": "object"

- "Instance": {

- "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",

- "id": "Instance",

+ "PlanNode": {

+ "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",

+ "id": "PlanNode",

"properties": {

- "labels": {

+ "kind": {

+ "description": "Used to determine the type of node. May be needed 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 used to directly embed a description of the node in its\nparent.",

+ "enum": [

+ "KIND_UNSPECIFIED",

+ "RELATIONAL",

+ "SCALAR"

+ ],

+ "enumDescriptions": [

+ "Not specified.",

+ "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.",

+ "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names."

+ ],

+ "type": "string"

+ },

+ "displayName": {

+ "description": "The display name for the node.",

+ "type": "string"

+ },

+ "childLinks": {

+ "description": "List of child node `index`es and their relationship to this parent.",

+ "items": {

+ "$ref": "ChildLink"

+ },

+ "type": "array"

+ },

+ "metadata": {

"additionalProperties": {

- "type": "string"

+ "description": "Properties of the object.",

+ "type": "any"

- "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 filter 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 characters 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\nSee 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 + \"_\" + value would prove problematic if we were to\nallow \"_\" in a future release.",

+ "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_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",

"type": "object"

- "config": {

- "description": "Required. The name of the instance's configuration. Values are of the form\n`projects/<project>/instanceConfigs/<configuration>`. See\nalso InstanceConfig and\nListInstanceConfigs.",

+ "executionStats": {

+ "additionalProperties": {

+ "description": "Properties of the object.",

+ "type": "any"

+ },

+ "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.",

+ "type": "object"

+ },

+ "shortRepresentation": {

+ "$ref": "ShortRepresentation",

+ "description": "Condensed representation for SCALAR nodes."

+ },

+ "index": {

+ "description": "The `PlanNode`'s index in node list.",

+ "format": "int32",

+ "type": "integer"

+ }

+ },

+ "type": "object"

+ },

+ "CreateInstanceMetadata": {

+ "description": "Metadata type for the operation returned by\nCreateInstance.",

+ "id": "CreateInstanceMetadata",

+ "properties": {

+ "cancelTime": {

+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",

+ "format": "google-datetime",

"type": "string"

- "state": {

- "description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.",

- "enum": [

- "STATE_UNSPECIFIED",

- "CREATING",

- "READY"

- ],

- "enumDescriptions": [

- "Not specified.",

- "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",

- "The instance is fully created and ready to do work such as\ncreating databases."

- ],

+ "endTime": {

+ "description": "The time at which this operation failed or was completed successfully.",

+ "format": "google-datetime",

+ "type": "string"

+ },

+ "instance": {

+ "$ref": "Instance",

+ "description": "The instance being created."

+ },

+ "startTime": {

+ "description": "The time at which the\nCreateInstance request was\nreceived.",

+ "format": "google-datetime",

"type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "AuditConfig": {

+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.",

+ "id": "AuditConfig",

+ "properties": {

+ "auditLogConfigs": {

+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",

+ "items": {

+ "$ref": "AuditLogConfig"

+ },

+ "type": "array"

- "name": {

- "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/<project>/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",

- "type": "string"

+ "exemptedMembers": {

+ "description": "Specifies the identities that are exempted from \"data access\" audit\nlogging for the `service` specified above.\nFollows the same format of Binding.members.\nThis field is deprecated in favor of per-permission-type exemptions.",

+ "items": {

+ "type": "string"

+ },

+ "type": "array"

- "displayName": {

- "description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.",

+ "service": {

+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",

"type": "string"

- },

- "nodeCount": {

- "description": "Required. The number of nodes allocated to this instance.",

- "format": "int32",

- "type": "integer"

}

"type": "object"

- "SetIamPolicyRequest": {

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

- "id": "SetIamPolicyRequest",

+ "ChildLink": {

+ "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",

+ "id": "ChildLink",

"properties": {

- "policy": {

- "$ref": "Policy",

- "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 empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."

+ "type": {

+ "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",

+ "type": "string"

- "updateMask": {

- "description": "OPTIONAL: A FieldMask specifying which fields 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 field is only used by Cloud IAM.",

- "format": "google-fieldmask",

+ "childIndex": {

+ "description": "The node to which the link points.",

+ "format": "int32",

+ "type": "integer"

+ },

+ "variable": {

+ "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name 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 output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.",

"type": "string"

}

"type": "object"

- "ListDatabasesResponse": {

- "description": "The response for ListDatabases.",

- "id": "ListDatabasesResponse",

+ "CloudAuditOptions": {

+ "description": "Write a Cloud Audit log",

+ "id": "CloudAuditOptions",

+ "properties": {},

+ "type": "object"

+ },

+ "Delete": {

+ "description": "Arguments to delete operations.",

+ "id": "Delete",

"properties": {

- "nextPageToken": {

- "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.",

+ "table": {

+ "description": "Required. The table whose rows will be deleted.",

"type": "string"

- "databases": {

- "description": "Databases that matched the request.",

- "items": {

- "$ref": "Database"

- },

- "type": "array"

+ "keySet": {

+ "$ref": "KeySet",

+ "description": "Required. The primary keys of the rows within table to delete."

}

"type": "object"

- "RollbackRequest": {

- "description": "The request for Rollback.",

- "id": "RollbackRequest",

+ "CommitRequest": {

+ "description": "The request for Commit.",

+ "id": "CommitRequest",

"properties": {

+ "singleUseTransaction": {

+ "$ref": "TransactionOptions",

+ "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary 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 application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead."

+ },

+ "mutations": {

+ "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",

+ "items": {

+ "$ref": "Mutation"

+ },

+ "type": "array"

+ },

"transactionId": {

- "description": "Required. The transaction to roll back.",

+ "description": "Commit a previously-started transaction.",

"format": "byte",

"type": "string"

}

"type": "object"

- "Transaction": {

- "description": "A transaction.",

- "id": "Transaction",

+ "BeginTransactionRequest": {

+ "description": "The request for BeginTransaction.",

+ "id": "BeginTransactionRequest",

"properties": {

- "readTimestamp": {

- "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",

- "format": "google-datetime",

- "type": "string"

- },

- "id": {

- "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",

- "format": "byte",

- "type": "string"

+ "options": {

+ "$ref": "TransactionOptions",

+ "description": "Required. Options for the new transaction."

}

"type": "object"

- "UpdateDatabaseDdlMetadata": {

- "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",

- "id": "UpdateDatabaseDdlMetadata",

+ "ListInstanceConfigsResponse": {

+ "description": "The response for ListInstanceConfigs.",

+ "id": "ListInstanceConfigsResponse",

"properties": {

- "database": {

- "description": "The database being modified.",

+ "nextPageToken": {

+ "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",

"type": "string"

- "statements": {

- "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.",

+ "instanceConfigs": {

+ "description": "The list of requested instance configurations.",

"items": {

- "type": "string"

+ "$ref": "InstanceConfig"

"type": "array"

- },

- "commitTimestamps": {

- "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.",

+ }

+ },

+ "type": "object"

+ },

+ "GetIamPolicyRequest": {

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

+ "id": "GetIamPolicyRequest",

+ "properties": {},

+ "type": "object"

+ },

+ "TestIamPermissionsResponse": {

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

+ "id": "TestIamPermissionsResponse",

+ "properties": {

+ "permissions": {

+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",

"items": {

- "format": "google-datetime",

"type": "string"

"type": "array"

@@ -2504,60 +2468,98 @@

"type": "object"

- "CounterOptions": {

- "description": "Options for counters",

- "id": "CounterOptions",

+ "CreateDatabaseMetadata": {

+ "description": "Metadata type for the operation returned by\nCreateDatabase.",

+ "id": "CreateDatabaseMetadata",

"properties": {

- "metric": {

- "description": "The metric to update.",

- "type": "string"

- },

- "field": {

- "description": "The field value to attribute.",

+ "database": {

+ "description": "The database being created.",

"type": "string"

}

"type": "object"

- "QueryPlan": {

- "description": "Contains an ordered list of nodes appearing in the query plan.",

- "id": "QueryPlan",

+ "Rule": {

+ "description": "A rule to be applied in a Policy.",

+ "id": "Rule",

"properties": {

- "planNodes": {

- "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresponds to its index in\n`plan_nodes`.",

+ "notIn": {

+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",

"items": {

- "$ref": "PlanNode"

+ "type": "string"

"type": "array"

- }

- },

- "type": "object"

- },

- "StructType": {

- "description": "`StructType` defines the fields of a STRUCT type.",

- "id": "StructType",

- "properties": {

- "fields": {

- "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nlists, where the order of field values matches the order of\nfields in the StructType. In turn, the order of fields\nmatches the order of columns in a read request, or the order of\nfields in the `SELECT` clause of a query.",

+ },

+ "description": {

+ "description": "Human-readable description of the rule.",

+ "type": "string"

+ },

+ "conditions": {

+ "description": "Additional restrictions that must be met",

"items": {

- "$ref": "Field"

+ "$ref": "Condition"

+ },

+ "type": "array"

+ },

+ "logConfig": {

+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",

+ "items": {

+ "$ref": "LogConfig"

+ },

+ "type": "array"

+ },

+ "in": {

+ "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",

+ "items": {

+ "type": "string"

+ },

+ "type": "array"

+ },

+ "permissions": {

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

+ "items": {

+ "type": "string"

"type": "array"

+ },

+ "action": {

+ "description": "Required",

+ "enum": [

+ "NO_ACTION",

+ "ALLOW",

+ "ALLOW_WITH_LOG",

+ "DENY",

+ "DENY_WITH_LOG",

+ "LOG"

+ ],

+ "enumDescriptions": [

+ "Default no action.",

+ "Matching 'Entries' grant access.",

+ "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",

+ "Matching 'Entries' deny access.",

+ "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",

+ "Matching 'Entries' tell IAM.Check callers to generate logs."

+ ],

+ "type": "string"

}

"type": "object"

- "Field": {

- "description": "Message representing a single field of a struct.",

- "id": "Field",

+ "LogConfig": {

+ "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names 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 request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",

+ "id": "LogConfig",

"properties": {

- "name": {

- "description": "The name of the field. For reads, this is the 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.",

- "type": "string"

+ "dataAccess": {

+ "$ref": "DataAccessOptions",

+ "description": "Data access options."

- "type": {

- "$ref": "Type",

- "description": "The type of the field."

+ "cloudAudit": {

+ "$ref": "CloudAuditOptions",

+ "description": "Cloud audit options."

+ },

+ "counter": {

+ "$ref": "CounterOptions",

+ "description": "Counter options."

}

"type": "object"

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