| Index: discovery/googleapis/spanner__v1.json
|
| diff --git a/discovery/googleapis/spanner__v1.json b/discovery/googleapis/spanner__v1.json
|
| index c37ca5d2b6c1bce8977c34ba27a617ff42a35de6..7703de4f8342451d8182288036105eb31598b59c 100644
|
| --- a/discovery/googleapis/spanner__v1.json
|
| +++ b/discovery/googleapis/spanner__v1.json
|
| @@ -25,8 +25,34 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "callback": {
|
| - "description": "JSONP",
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "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"
|
| },
|
| @@ -43,6 +69,11 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "callback": {
|
| + "description": "JSONP",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| @@ -79,37 +110,6 @@
|
| "description": "Pretty-print response.",
|
| "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"
|
| - },
|
| - "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"
|
| }
|
| },
|
| "protocol": "rest",
|
| @@ -118,16 +118,16 @@
|
| "resources": {
|
| "instances": {
|
| "methods": {
|
| - "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",
|
| - "id": "spanner.projects.instances.patch",
|
| + "delete": {
|
| + "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted.",
|
| + "httpMethod": "DELETE",
|
| + "id": "spanner.projects.instances.delete",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| "parameters": {
|
| "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.",
|
| + "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/<project>/instances/<instance>`",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/instances/[^/]+$",
|
| "required": true,
|
| @@ -135,177 +135,177 @@
|
| }
|
| },
|
| "path": "v1/{+name}",
|
| - "request": {
|
| - "$ref": "UpdateInstanceRequest"
|
| - },
|
| "response": {
|
| - "$ref": "Operation"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Gets information about a particular instance.",
|
| + "list": {
|
| + "description": "Lists all instances in the given project.",
|
| "httpMethod": "GET",
|
| - "id": "spanner.projects.instances.get",
|
| + "id": "spanner.projects.instances.list",
|
| "parameterOrder": [
|
| - "name"
|
| + "parent"
|
| ],
|
| "parameters": {
|
| - "name": {
|
| - "description": "Required. The name of the requested instance. Values are of the form\n`projects/<project>/instances/<instance>`.",
|
| + "parent": {
|
| + "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/<project>`.",
|
| "location": "path",
|
| - "pattern": "^projects/[^/]+/instances/[^/]+$",
|
| + "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"
|
| + },
|
| + "pageToken": {
|
| + "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| }
|
| },
|
| - "path": "v1/{+name}",
|
| + "path": "v1/{+parent}/instances",
|
| "response": {
|
| - "$ref": "Instance"
|
| + "$ref": "ListInstancesResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "testIamPermissions": {
|
| - "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
|
| + "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.testIamPermissions",
|
| + "id": "spanner.projects.instances.create",
|
| "parameterOrder": [
|
| - "resource"
|
| + "parent"
|
| ],
|
| "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.",
|
| + "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/[^/]+/instances/[^/]+$",
|
| + "pattern": "^projects/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:testIamPermissions",
|
| + "path": "v1/{+parent}/instances",
|
| "request": {
|
| - "$ref": "TestIamPermissionsRequest"
|
| + "$ref": "CreateInstanceRequest"
|
| },
|
| "response": {
|
| - "$ref": "TestIamPermissionsResponse"
|
| + "$ref": "Operation"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "delete": {
|
| - "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted.",
|
| - "httpMethod": "DELETE",
|
| - "id": "spanner.projects.instances.delete",
|
| + "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": [
|
| - "name"
|
| + "resource"
|
| ],
|
| "parameters": {
|
| - "name": {
|
| - "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/<project>/instances/<instance>`",
|
| + "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/{+name}",
|
| + "path": "v1/{+resource}:setIamPolicy",
|
| + "request": {
|
| + "$ref": "SetIamPolicyRequest"
|
| + },
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "Policy"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "list": {
|
| - "description": "Lists all instances in the given project.",
|
| - "httpMethod": "GET",
|
| - "id": "spanner.projects.instances.list",
|
| + "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": [
|
| - "parent"
|
| + "resource"
|
| ],
|
| "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",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto 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 instances is\nrequested. Values are of the form `projects/<project>`.",
|
| + "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/[^/]+$",
|
| + "pattern": "^projects/[^/]+/instances/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+parent}/instances",
|
| + "path": "v1/{+resource}:getIamPolicy",
|
| + "request": {
|
| + "$ref": "GetIamPolicyRequest"
|
| + },
|
| "response": {
|
| - "$ref": "ListInstancesResponse"
|
| + "$ref": "Policy"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "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",
|
| + "get": {
|
| + "description": "Gets information about a particular instance.",
|
| + "httpMethod": "GET",
|
| + "id": "spanner.projects.instances.get",
|
| "parameterOrder": [
|
| - "resource"
|
| + "name"
|
| ],
|
| "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.",
|
| + "name": {
|
| + "description": "Required. The name of the requested instance. Values are of the form\n`projects/<project>/instances/<instance>`.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/instances/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:setIamPolicy",
|
| - "request": {
|
| - "$ref": "SetIamPolicyRequest"
|
| - },
|
| + "path": "v1/{+name}",
|
| "response": {
|
| - "$ref": "Policy"
|
| + "$ref": "Instance"
|
| },
|
| "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",
|
| + "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",
|
| + "id": "spanner.projects.instances.patch",
|
| "parameterOrder": [
|
| - "parent"
|
| + "name"
|
| ],
|
| "parameters": {
|
| - "parent": {
|
| - "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/<project>`.",
|
| + "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.",
|
| "location": "path",
|
| - "pattern": "^projects/[^/]+$",
|
| + "pattern": "^projects/[^/]+/instances/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+parent}/instances",
|
| + "path": "v1/{+name}",
|
| "request": {
|
| - "$ref": "CreateInstanceRequest"
|
| + "$ref": "UpdateInstanceRequest"
|
| },
|
| "response": {
|
| "$ref": "Operation"
|
| @@ -314,28 +314,28 @@
|
| "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.",
|
| + "testIamPermissions": {
|
| + "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
|
| "httpMethod": "POST",
|
| - "id": "spanner.projects.instances.getIamPolicy",
|
| + "id": "spanner.projects.instances.testIamPermissions",
|
| "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.",
|
| + "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/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:getIamPolicy",
|
| + "path": "v1/{+resource}:testIamPermissions",
|
| "request": {
|
| - "$ref": "GetIamPolicyRequest"
|
| + "$ref": "TestIamPermissionsRequest"
|
| },
|
| "response": {
|
| - "$ref": "Policy"
|
| + "$ref": "TestIamPermissionsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| @@ -345,73 +345,87 @@
|
| "resources": {
|
| "databases": {
|
| "methods": {
|
| - "get": {
|
| - "description": "Gets the state of a Cloud Spanner database.",
|
| + "list": {
|
| + "description": "Lists Cloud Spanner databases.",
|
| "httpMethod": "GET",
|
| - "id": "spanner.projects.instances.databases.get",
|
| + "id": "spanner.projects.instances.databases.list",
|
| "parameterOrder": [
|
| - "name"
|
| + "parent"
|
| ],
|
| "parameters": {
|
| - "name": {
|
| - "description": "Required. The name of the requested database. Values are of the form\n`projects/<project>/instances/<instance>/databases/<database>`.",
|
| + "parent": {
|
| + "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/<project>/instances/<instance>`.",
|
| "location": "path",
|
| - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
|
| + "pattern": "^projects/[^/]+/instances/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "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/{+name}",
|
| + "path": "v1/{+parent}/databases",
|
| "response": {
|
| - "$ref": "Database"
|
| + "$ref": "ListDatabasesResponse"
|
| },
|
| "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",
|
| + "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.setIamPolicy",
|
| "parameterOrder": [
|
| - "database"
|
| + "resource"
|
| ],
|
| "parameters": {
|
| - "database": {
|
| - "description": "Required. The database to be dropped.",
|
| + "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/[^/]+/databases/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+database}",
|
| + "path": "v1/{+resource}:setIamPolicy",
|
| + "request": {
|
| + "$ref": "SetIamPolicyRequest"
|
| + },
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "Policy"
|
| },
|
| "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",
|
| + "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.create",
|
| "parameterOrder": [
|
| - "database"
|
| + "parent"
|
| ],
|
| "parameters": {
|
| - "database": {
|
| - "description": "Required. The database to update.",
|
| + "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/{+database}/ddl",
|
| + "path": "v1/{+parent}/databases",
|
| "request": {
|
| - "$ref": "UpdateDatabaseDdlRequest"
|
| + "$ref": "CreateDatabaseRequest"
|
| },
|
| "response": {
|
| "$ref": "Operation"
|
| @@ -420,168 +434,154 @@
|
| "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.",
|
| + "getIamPolicy": {
|
| + "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
|
| "httpMethod": "POST",
|
| - "id": "spanner.projects.instances.databases.testIamPermissions",
|
| + "id": "spanner.projects.instances.databases.getIamPolicy",
|
| "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.",
|
| + "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/[^/]+/databases/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:testIamPermissions",
|
| + "path": "v1/{+resource}:getIamPolicy",
|
| "request": {
|
| - "$ref": "TestIamPermissionsRequest"
|
| + "$ref": "GetIamPolicyRequest"
|
| },
|
| "response": {
|
| - "$ref": "TestIamPermissionsResponse"
|
| + "$ref": "Policy"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "getDdl": {
|
| - "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API.",
|
| + "get": {
|
| + "description": "Gets the state of a Cloud Spanner database.",
|
| "httpMethod": "GET",
|
| - "id": "spanner.projects.instances.databases.getDdl",
|
| + "id": "spanner.projects.instances.databases.get",
|
| "parameterOrder": [
|
| - "database"
|
| + "name"
|
| ],
|
| "parameters": {
|
| - "database": {
|
| - "description": "Required. The database whose schema we wish to get.",
|
| + "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/{+database}/ddl",
|
| + "path": "v1/{+name}",
|
| "response": {
|
| - "$ref": "GetDatabaseDdlResponse"
|
| + "$ref": "Database"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "list": {
|
| - "description": "Lists Cloud Spanner databases.",
|
| - "httpMethod": "GET",
|
| - "id": "spanner.projects.instances.databases.list",
|
| + "dropDatabase": {
|
| + "description": "Drops (aka deletes) a Cloud Spanner database.",
|
| + "httpMethod": "DELETE",
|
| + "id": "spanner.projects.instances.databases.dropDatabase",
|
| "parameterOrder": [
|
| - "parent"
|
| + "database"
|
| ],
|
| "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>`.",
|
| + "database": {
|
| + "description": "Required. The database to be dropped.",
|
| "location": "path",
|
| - "pattern": "^projects/[^/]+/instances/[^/]+$",
|
| + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+parent}/databases",
|
| + "path": "v1/{+database}",
|
| "response": {
|
| - "$ref": "ListDatabasesResponse"
|
| + "$ref": "Empty"
|
| },
|
| "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.",
|
| - "httpMethod": "POST",
|
| - "id": "spanner.projects.instances.databases.setIamPolicy",
|
| + "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": [
|
| - "resource"
|
| + "database"
|
| ],
|
| "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.",
|
| + "database": {
|
| + "description": "Required. The database to update.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:setIamPolicy",
|
| + "path": "v1/{+database}/ddl",
|
| "request": {
|
| - "$ref": "SetIamPolicyRequest"
|
| + "$ref": "UpdateDatabaseDdlRequest"
|
| },
|
| "response": {
|
| - "$ref": "Policy"
|
| + "$ref": "Operation"
|
| },
|
| "scopes": [
|
| "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.",
|
| + "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.create",
|
| + "id": "spanner.projects.instances.databases.testIamPermissions",
|
| "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": {
|
| + "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/[^/]+$",
|
| + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+parent}/databases",
|
| + "path": "v1/{+resource}:testIamPermissions",
|
| "request": {
|
| - "$ref": "CreateDatabaseRequest"
|
| + "$ref": "TestIamPermissionsRequest"
|
| },
|
| "response": {
|
| - "$ref": "Operation"
|
| + "$ref": "TestIamPermissionsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "getIamPolicy": {
|
| - "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
|
| - "httpMethod": "POST",
|
| - "id": "spanner.projects.instances.databases.getIamPolicy",
|
| + "getDdl": {
|
| + "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API.",
|
| + "httpMethod": "GET",
|
| + "id": "spanner.projects.instances.databases.getDdl",
|
| "parameterOrder": [
|
| - "resource"
|
| + "database"
|
| ],
|
| "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.",
|
| + "database": {
|
| + "description": "Required. The database whose schema we wish to get.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:getIamPolicy",
|
| - "request": {
|
| - "$ref": "GetIamPolicyRequest"
|
| - },
|
| + "path": "v1/{+database}/ddl",
|
| "response": {
|
| - "$ref": "Policy"
|
| + "$ref": "GetDatabaseDdlResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| @@ -591,6 +591,54 @@
|
| "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",
|
| @@ -599,11 +647,6 @@
|
| "name"
|
| ],
|
| "parameters": {
|
| - "filter": {
|
| - "description": "The standard list filter.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "name": {
|
| "description": "The name of the operation collection.",
|
| "location": "path",
|
| @@ -621,6 +664,11 @@
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| + },
|
| + "filter": {
|
| + "description": "The standard list filter.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/{+name}",
|
| @@ -654,54 +702,6 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| - },
|
| - "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"
|
| - ]
|
| }
|
| }
|
| },
|
| @@ -758,25 +758,28 @@
|
| "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",
|
| + "commit": {
|
| + "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
|
| + "httpMethod": "POST",
|
| + "id": "spanner.projects.instances.databases.sessions.commit",
|
| "parameterOrder": [
|
| - "name"
|
| + "session"
|
| ],
|
| "parameters": {
|
| - "name": {
|
| - "description": "Required. The name of the session to delete.",
|
| + "session": {
|
| + "description": "Required. The session in which the transaction to be committed is running.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+name}",
|
| + "path": "v1/{+session}:commit",
|
| + "request": {
|
| + "$ref": "CommitRequest"
|
| + },
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "CommitResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| @@ -809,28 +812,25 @@
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "commit": {
|
| - "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
|
| - "httpMethod": "POST",
|
| - "id": "spanner.projects.instances.databases.sessions.commit",
|
| + "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 transaction to be committed is running.",
|
| + "name": {
|
| + "description": "Required. The name of the session to delete.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+session}:commit",
|
| - "request": {
|
| - "$ref": "CommitRequest"
|
| - },
|
| + "path": "v1/{+name}",
|
| "response": {
|
| - "$ref": "CommitResponse"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| @@ -863,55 +863,55 @@
|
| "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`.",
|
| + "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.rollback",
|
| + "id": "spanner.projects.instances.databases.sessions.streamingRead",
|
| "parameterOrder": [
|
| "session"
|
| ],
|
| "parameters": {
|
| "session": {
|
| - "description": "Required. The session in which the transaction to roll back is running.",
|
| + "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}:rollback",
|
| + "path": "v1/{+session}:streamingRead",
|
| "request": {
|
| - "$ref": "RollbackRequest"
|
| + "$ref": "ReadRequest"
|
| },
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "PartialResultSet"
|
| },
|
| "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.",
|
| + "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.streamingRead",
|
| + "id": "spanner.projects.instances.databases.sessions.rollback",
|
| "parameterOrder": [
|
| "session"
|
| ],
|
| "parameters": {
|
| "session": {
|
| - "description": "Required. The session in which the read 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}:streamingRead",
|
| + "path": "v1/{+session}:rollback",
|
| "request": {
|
| - "$ref": "ReadRequest"
|
| + "$ref": "RollbackRequest"
|
| },
|
| "response": {
|
| - "$ref": "PartialResultSet"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| @@ -974,56 +974,40 @@
|
| },
|
| "operations": {
|
| "methods": {
|
| - "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": {
|
| + "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.operations.cancel",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| "parameters": {
|
| - "filter": {
|
| - "description": "The standard list filter.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "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"
|
| }
|
| },
|
| - "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": {
|
| + "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.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,
|
| @@ -1032,46 +1016,62 @@
|
| },
|
| "path": "v1/{+name}",
|
| "response": {
|
| - "$ref": "Operation"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "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.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": {
|
| - "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.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,
|
| @@ -1080,7 +1080,7 @@
|
| },
|
| "path": "v1/{+name}",
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "Operation"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform"
|
| @@ -1100,12 +1100,6 @@
|
| "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",
|
| @@ -1117,6 +1111,12 @@
|
| "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"
|
| }
|
| },
|
| "path": "v1/{+parent}/instanceConfigs",
|
| @@ -1156,1034 +1156,1015 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170317",
|
| + "revision": "20170324",
|
| "rootUrl": "https://spanner.googleapis.com/",
|
| "schemas": {
|
| - "Session": {
|
| - "description": "A session in the Cloud Spanner API.",
|
| - "id": "Session",
|
| - "properties": {
|
| - "name": {
|
| - "description": "Required. The name of the session.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListInstancesResponse": {
|
| - "description": "The response for ListInstances.",
|
| - "id": "ListInstancesResponse",
|
| + "Policy": {
|
| + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
|
| + "id": "Policy",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
|
| - "type": "string"
|
| + "iamOwned": {
|
| + "type": "boolean"
|
| },
|
| - "instances": {
|
| - "description": "The list of requested instances.",
|
| + "rules": {
|
| + "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
|
| "items": {
|
| - "$ref": "Instance"
|
| + "$ref": "Rule"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "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": {
|
| - "endOpen": {
|
| - "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
|
| + },
|
| + "version": {
|
| + "description": "Version of the `Policy`. The default version is 0.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "auditConfigs": {
|
| + "description": "Specifies cloud audit logging configuration for this policy.",
|
| "items": {
|
| - "type": "any"
|
| + "$ref": "AuditConfig"
|
| },
|
| "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`.",
|
| + "bindings": {
|
| + "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
|
| "items": {
|
| - "type": "any"
|
| + "$ref": "Binding"
|
| },
|
| "type": "array"
|
| },
|
| - "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"
|
| + "etag": {
|
| + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ReadRequest": {
|
| + "description": "The request for Read and\nStreamingRead.",
|
| + "id": "ReadRequest",
|
| + "properties": {
|
| + "limit": {
|
| + "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| - "startOpen": {
|
| - "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
|
| + "index": {
|
| + "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\nand sorting result rows. See key_set for further information.",
|
| + "type": "string"
|
| + },
|
| + "keySet": {
|
| + "$ref": "KeySet",
|
| + "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows."
|
| + },
|
| + "columns": {
|
| + "description": "The columns of table to be returned for each row matching\nthis request.",
|
| "items": {
|
| - "type": "any"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "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 read,\n`resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new read to resume where the last read left off. The\nrest of the request parameters must exactly match the request\nthat yielded this token.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "table": {
|
| + "description": "Required. The name of the table in the database to be read.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ShortRepresentation": {
|
| - "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
|
| - "id": "ShortRepresentation",
|
| + "Write": {
|
| + "description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",
|
| + "id": "Write",
|
| "properties": {
|
| - "description": {
|
| - "description": "A string representation of the expression subtree rooted at this node.",
|
| + "table": {
|
| + "description": "Required. The table whose rows will be written.",
|
| "type": "string"
|
| },
|
| - "subqueries": {
|
| - "additionalProperties": {
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "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": {
|
| + "type": "string"
|
| },
|
| - "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": "array"
|
| + },
|
| + "values": {
|
| + "description": "The values to be written. `values` can contain more than one\nlist of values. If it does, then multiple rows are written, one\nfor each entry in `values`. Each list in `values` must have\nexactly as many entries as there are entries in columns\nabove. Sending multiple lists is equivalent to sending multiple\n`Mutation`s, each containing one `values` entry and repeating\ntable and columns. Individual values in each list are\nencoded as described here.",
|
| + "items": {
|
| + "items": {
|
| + "type": "any"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "InstanceConfig": {
|
| - "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",
|
| - "id": "InstanceConfig",
|
| + "DataAccessOptions": {
|
| + "description": "Write a Data Access (Gin) log",
|
| + "id": "DataAccessOptions",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "ReadWrite": {
|
| + "description": "Options for read-write transactions.",
|
| + "id": "ReadWrite",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "Operation": {
|
| + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
| + "id": "Operation",
|
| "properties": {
|
| - "displayName": {
|
| - "description": "The name of this instance configuration as it appears in UIs.",
|
| - "type": "string"
|
| + "error": {
|
| + "$ref": "Status",
|
| + "description": "The error result of the operation in case of failure or cancellation."
|
| + },
|
| + "metadata": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
| + "type": "object"
|
| + },
|
| + "done": {
|
| + "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
|
| + "type": "boolean"
|
| + },
|
| + "response": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
| + "type": "object"
|
| },
|
| "name": {
|
| - "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/<project>/instanceConfigs/a-z*`",
|
| + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "UpdateInstanceRequest": {
|
| - "description": "The request for UpdateInstance.",
|
| - "id": "UpdateInstanceRequest",
|
| + "Status": {
|
| + "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
| + "id": "Status",
|
| "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."
|
| + "details": {
|
| + "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
|
| + "items": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| },
|
| - "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",
|
| + "code": {
|
| + "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "message": {
|
| + "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
|
| "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",
|
| + "ResultSet": {
|
| + "description": "Results from Read or\nExecuteSql.",
|
| + "id": "ResultSet",
|
| "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."
|
| + "metadata": {
|
| + "$ref": "ResultSetMetadata",
|
| + "description": "Metadata about the result set, such as row type information."
|
| },
|
| - "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."
|
| + "stats": {
|
| + "$ref": "ResultSetStats",
|
| + "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode."
|
| + },
|
| + "rows": {
|
| + "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nhere.",
|
| + "items": {
|
| + "items": {
|
| + "type": "any"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CreateDatabaseRequest": {
|
| - "description": "The request for CreateDatabase.",
|
| - "id": "CreateDatabaseRequest",
|
| + "Binding": {
|
| + "description": "Associates `members` with a `role`.",
|
| + "id": "Binding",
|
| "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.",
|
| + "members": {
|
| + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "role": {
|
| + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CreateInstanceRequest": {
|
| - "description": "The request for CreateInstance.",
|
| - "id": "CreateInstanceRequest",
|
| + "UpdateDatabaseDdlRequest": {
|
| + "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
|
| + "id": "UpdateDatabaseDdlRequest",
|
| "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"
|
| + "statements": {
|
| + "description": "DDL statements to be applied to the database.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| },
|
| - "instance": {
|
| - "$ref": "Instance",
|
| - "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `<parent>/instances/<instance_id>`."
|
| + "operationId": {
|
| + "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `<database>/operations/<operation_id>`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Condition": {
|
| - "description": "A condition to be met.",
|
| - "id": "Condition",
|
| + "PartialResultSet": {
|
| + "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
|
| + "id": "PartialResultSet",
|
| "properties": {
|
| - "value": {
|
| - "description": "DEPRECATED. Use 'values' instead.",
|
| - "type": "string"
|
| + "stats": {
|
| + "$ref": "ResultSetStats",
|
| + "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream."
|
| },
|
| - "sys": {
|
| - "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
|
| - "enum": [
|
| - "NO_ATTR",
|
| - "REGION",
|
| - "SERVICE",
|
| - "NAME",
|
| - "IP"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Default non-attribute type",
|
| - "Region of the resource",
|
| - "Service name",
|
| - "Resource name",
|
| - "IP address of the caller"
|
| - ],
|
| - "type": "string"
|
| + "chunkedValue": {
|
| + "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
|
| + "type": "boolean"
|
| },
|
| - "iam": {
|
| - "description": "Trusted attributes supplied by the IAM system.",
|
| - "enum": [
|
| - "NO_ATTR",
|
| - "AUTHORITY",
|
| - "ATTRIBUTION",
|
| - "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).",
|
| - "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"
|
| + "metadata": {
|
| + "$ref": "ResultSetMetadata",
|
| + "description": "Metadata about the result set, such as row type information.\nOnly present in the first response."
|
| },
|
| "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": [
|
| - "NO_OP",
|
| - "EQUALS",
|
| - "NOT_EQUALS",
|
| - "IN",
|
| - "NOT_IN",
|
| - "DISCHARGED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Default no-op.",
|
| - "DEPRECATED. Use IN instead.",
|
| - "DEPRECATED. Use NOT_IN instead.",
|
| - "Set-inclusion check.",
|
| - "Set-exclusion check.",
|
| - "Subject is discharged"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "svc": {
|
| - "description": "Trusted attributes discharged by the service.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AuditLogConfig": {
|
| - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
| - "id": "AuditLogConfig",
|
| - "properties": {
|
| - "exemptedMembers": {
|
| - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
| + "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" => \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] => [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] => [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] => [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} => {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} => {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} => {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
|
| "items": {
|
| - "type": "string"
|
| + "type": "any"
|
| },
|
| "type": "array"
|
| },
|
| - "logType": {
|
| - "description": "The log type that this config enables.",
|
| - "enum": [
|
| - "LOG_TYPE_UNSPECIFIED",
|
| - "ADMIN_READ",
|
| - "DATA_WRITE",
|
| - "DATA_READ"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Default case. Should never be this.",
|
| - "Admin reads. Example: CloudIAM getIamPolicy",
|
| - "Data writes. Example: CloudSQL Users create",
|
| - "Data reads. Example: CloudSQL Users list"
|
| - ],
|
| + "resumeToken": {
|
| + "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
|
| + "format": "byte",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ReadOnly": {
|
| - "description": "Options for read-only transactions.",
|
| - "id": "ReadOnly",
|
| + "UpdateInstanceMetadata": {
|
| + "description": "Metadata type for the operation returned by\nUpdateInstance.",
|
| + "id": "UpdateInstanceMetadata",
|
| "properties": {
|
| - "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.",
|
| + "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"
|
| },
|
| - "maxStaleness": {
|
| - "description": "Read data at a timestamp >= `NOW - max_staleness`\nseconds. Guarantees that all writes that have committed more\nthan the specified number of seconds ago are visible. Because\nCloud Spanner chooses the exact timestamp, this mode works even if\nthe client's local clock is substantially skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshest data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.",
|
| - "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.",
|
| + "endTime": {
|
| + "description": "The time at which this operation failed or was completed successfully.",
|
| "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"
|
| + "instance": {
|
| + "$ref": "Instance",
|
| + "description": "The desired end state of the update."
|
| },
|
| - "exactStaleness": {
|
| - "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",
|
| + "startTime": {
|
| + "description": "The time at which UpdateInstance\nrequest was received.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ExecuteSqlRequest": {
|
| - "description": "The request for ExecuteSql and\nExecuteStreamingSql.",
|
| - "id": "ExecuteSqlRequest",
|
| + "ListOperationsResponse": {
|
| + "description": "The response message for Operations.ListOperations.",
|
| + "id": "ListOperationsResponse",
|
| "properties": {
|
| - "paramTypes": {
|
| - "additionalProperties": {
|
| - "$ref": "Type"
|
| - },
|
| - "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
|
| - "type": "object"
|
| - },
|
| - "sql": {
|
| - "description": "Required. The SQL query string.",
|
| + "nextPageToken": {
|
| + "description": "The standard List next-page token.",
|
| "type": "string"
|
| },
|
| - "params": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| + "operations": {
|
| + "description": "A list of operations that matches the specified filter in the request.",
|
| + "items": {
|
| + "$ref": "Operation"
|
| },
|
| - "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"
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ResultSetMetadata": {
|
| + "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": "TransactionSelector",
|
| - "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
|
| + "$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."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "TransactionSelector": {
|
| + "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
|
| + "id": "TransactionSelector",
|
| + "properties": {
|
| + "begin": {
|
| + "$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."
|
| },
|
| - "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.",
|
| + "id": {
|
| + "description": "Execute the read or SQL query in a previously-started transaction.",
|
| "format": "byte",
|
| "type": "string"
|
| + },
|
| + "singleUse": {
|
| + "$ref": "TransactionOptions",
|
| + "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Policy": {
|
| - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
|
| - "id": "Policy",
|
| + "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": {
|
| - "iamOwned": {
|
| - "type": "boolean"
|
| - },
|
| - "rules": {
|
| - "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
|
| - "items": {
|
| - "$ref": "Rule"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "version": {
|
| - "description": "Version of the `Policy`. The default version is 0.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "auditConfigs": {
|
| - "description": "Specifies cloud audit logging configuration for this policy.",
|
| + "ranges": {
|
| + "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
|
| "items": {
|
| - "$ref": "AuditConfig"
|
| + "$ref": "KeyRange"
|
| },
|
| "type": "array"
|
| },
|
| - "bindings": {
|
| - "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
|
| + "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": {
|
| - "$ref": "Binding"
|
| + "items": {
|
| + "type": "any"
|
| + },
|
| + "type": "array"
|
| },
|
| "type": "array"
|
| },
|
| - "etag": {
|
| - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
| - "format": "byte",
|
| - "type": "string"
|
| + "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"
|
| },
|
| - "ReadRequest": {
|
| - "description": "The request for Read and\nStreamingRead.",
|
| - "id": "ReadRequest",
|
| + "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": {
|
| - "limit": {
|
| - "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
|
| - "format": "int64",
|
| - "type": "string"
|
| + "delete": {
|
| + "$ref": "Delete",
|
| + "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
|
| },
|
| - "index": {
|
| - "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\nand sorting result rows. See key_set for further information.",
|
| - "type": "string"
|
| + "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`."
|
| },
|
| - "keySet": {
|
| - "$ref": "KeySet",
|
| - "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows."
|
| - },
|
| - "columns": {
|
| - "description": "The columns of table to be returned for each row matching\nthis request.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "transaction": {
|
| - "$ref": "TransactionSelector",
|
| - "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
|
| + "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."
|
| },
|
| - "resumeToken": {
|
| - "description": "If this request is resuming a previously interrupted read,\n`resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new read to resume where the last read left off. The\nrest of the request parameters must exactly match the request\nthat yielded this token.",
|
| - "format": "byte",
|
| - "type": "string"
|
| + "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`."
|
| },
|
| - "table": {
|
| - "description": "Required. The name of the table in the database to be read.",
|
| - "type": "string"
|
| + "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`."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Write": {
|
| - "description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",
|
| - "id": "Write",
|
| + "GetDatabaseDdlResponse": {
|
| + "description": "The response for GetDatabaseDdl.",
|
| + "id": "GetDatabaseDdlResponse",
|
| "properties": {
|
| - "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.",
|
| + "statements": {
|
| + "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "values": {
|
| - "description": "The values to be written. `values` can contain more than one\nlist of values. If it does, then multiple rows are written, one\nfor each entry in `values`. Each list in `values` must have\nexactly as many entries as there are entries in columns\nabove. Sending multiple lists is equivalent to sending multiple\n`Mutation`s, each containing one `values` entry and repeating\ntable and columns. Individual values in each list are\nencoded as described here.",
|
| - "items": {
|
| - "items": {
|
| - "type": "any"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "table": {
|
| - "description": "Required. The table whose rows will be written.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ReadWrite": {
|
| - "description": "Options for read-write transactions.",
|
| - "id": "ReadWrite",
|
| - "properties": {},
|
| + "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"
|
| },
|
| - "DataAccessOptions": {
|
| - "description": "Write a Data Access (Gin) log",
|
| - "id": "DataAccessOptions",
|
| - "properties": {},
|
| + "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, the\nfollowing default mask 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"
|
| },
|
| - "Operation": {
|
| - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
| - "id": "Operation",
|
| + "Instance": {
|
| + "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
|
| + "id": "Instance",
|
| "properties": {
|
| - "done": {
|
| - "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
|
| - "type": "boolean"
|
| + "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"
|
| },
|
| - "response": {
|
| + "nodeCount": {
|
| + "description": "Required. The number of nodes allocated to this instance.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "labels": {
|
| "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| + "type": "string"
|
| },
|
| - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
| + "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"
|
| },
|
| - "name": {
|
| - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
| + "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"
|
| },
|
| - "error": {
|
| - "$ref": "Status",
|
| - "description": "The error result of the operation in case of failure or cancellation."
|
| + "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"
|
| },
|
| - "metadata": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
| - "type": "object"
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ResultSet": {
|
| - "description": "Results from Read or\nExecuteSql.",
|
| - "id": "ResultSet",
|
| + "ListDatabasesResponse": {
|
| + "description": "The response for ListDatabases.",
|
| + "id": "ListDatabasesResponse",
|
| "properties": {
|
| - "stats": {
|
| - "$ref": "ResultSetStats",
|
| - "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode."
|
| + "nextPageToken": {
|
| + "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.",
|
| + "type": "string"
|
| },
|
| - "rows": {
|
| - "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nhere.",
|
| + "databases": {
|
| + "description": "Databases that matched the request.",
|
| "items": {
|
| - "items": {
|
| - "type": "any"
|
| - },
|
| - "type": "array"
|
| + "$ref": "Database"
|
| },
|
| "type": "array"
|
| - },
|
| - "metadata": {
|
| - "$ref": "ResultSetMetadata",
|
| - "description": "Metadata about the result set, such as row type information."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Status": {
|
| - "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
| - "id": "Status",
|
| + "RollbackRequest": {
|
| + "description": "The request for Rollback.",
|
| + "id": "RollbackRequest",
|
| "properties": {
|
| - "code": {
|
| - "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "message": {
|
| - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
|
| + "transactionId": {
|
| + "description": "Required. The transaction to roll back.",
|
| + "format": "byte",
|
| "type": "string"
|
| - },
|
| - "details": {
|
| - "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
|
| - "items": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "type": "object"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "UpdateDatabaseDdlRequest": {
|
| - "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
|
| - "id": "UpdateDatabaseDdlRequest",
|
| + "Transaction": {
|
| + "description": "A transaction.",
|
| + "id": "Transaction",
|
| "properties": {
|
| - "statements": {
|
| - "description": "DDL statements to be applied to the database.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "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"
|
| },
|
| - "operationId": {
|
| - "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `<database>/operations/<operation_id>`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Binding": {
|
| - "description": "Associates `members` with a `role`.",
|
| - "id": "Binding",
|
| + "UpdateDatabaseDdlMetadata": {
|
| + "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
|
| + "id": "UpdateDatabaseDdlMetadata",
|
| "properties": {
|
| - "members": {
|
| - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
|
| + "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"
|
| },
|
| - "role": {
|
| - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
|
| + "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"
|
| },
|
| - "PartialResultSet": {
|
| - "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
|
| - "id": "PartialResultSet",
|
| + "CounterOptions": {
|
| + "description": "Options for counters",
|
| + "id": "CounterOptions",
|
| "properties": {
|
| - "chunkedValue": {
|
| - "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
|
| - "type": "boolean"
|
| - },
|
| - "metadata": {
|
| - "$ref": "ResultSetMetadata",
|
| - "description": "Metadata about the result set, such as row type information.\nOnly present in the first response."
|
| - },
|
| - "values": {
|
| - "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" => \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] => [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] => [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] => [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} => {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} => {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} => {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
|
| - "items": {
|
| - "type": "any"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "resumeToken": {
|
| - "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
|
| - "format": "byte",
|
| + "metric": {
|
| + "description": "The metric to update.",
|
| "type": "string"
|
| },
|
| - "stats": {
|
| - "$ref": "ResultSetStats",
|
| - "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream."
|
| + "field": {
|
| + "description": "The field value to attribute.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListOperationsResponse": {
|
| - "description": "The response message for Operations.ListOperations.",
|
| - "id": "ListOperationsResponse",
|
| + "QueryPlan": {
|
| + "description": "Contains an ordered list of nodes appearing in the query plan.",
|
| + "id": "QueryPlan",
|
| "properties": {
|
| - "operations": {
|
| - "description": "A list of operations that matches the specified filter in the request.",
|
| + "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": {
|
| - "$ref": "Operation"
|
| + "$ref": "PlanNode"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "The standard List next-page token.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "UpdateInstanceMetadata": {
|
| - "description": "Metadata type for the operation returned by\nUpdateInstance.",
|
| - "id": "UpdateInstanceMetadata",
|
| + "StructType": {
|
| + "description": "`StructType` defines the fields of a STRUCT type.",
|
| + "id": "StructType",
|
| "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"
|
| - },
|
| - "endTime": {
|
| - "description": "The time at which this operation failed or was completed successfully.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "instance": {
|
| - "$ref": "Instance",
|
| - "description": "The desired end state of the update."
|
| - },
|
| - "startTime": {
|
| - "description": "The time at which UpdateInstance\nrequest was received.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "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": "Field"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ResultSetMetadata": {
|
| - "description": "Metadata about a ResultSet or PartialResultSet.",
|
| - "id": "ResultSetMetadata",
|
| + "Field": {
|
| + "description": "Message representing a single field of a struct.",
|
| + "id": "Field",
|
| "properties": {
|
| - "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."
|
| + "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"
|
| },
|
| - "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": {
|
| + "$ref": "Type",
|
| + "description": "The type of the field."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "TransactionSelector": {
|
| - "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
|
| - "id": "TransactionSelector",
|
| + "ResultSetStats": {
|
| + "description": "Additional statistics about a ResultSet or PartialResultSet.",
|
| + "id": "ResultSetStats",
|
| "properties": {
|
| - "singleUse": {
|
| - "$ref": "TransactionOptions",
|
| - "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query."
|
| - },
|
| - "begin": {
|
| - "$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."
|
| + "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"
|
| },
|
| - "id": {
|
| - "description": "Execute the read or SQL query in a previously-started transaction.",
|
| - "format": "byte",
|
| - "type": "string"
|
| + "queryPlan": {
|
| + "$ref": "QueryPlan",
|
| + "description": "QueryPlan for the query associated with this result."
|
| }
|
| },
|
| "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",
|
| + "TestIamPermissionsRequest": {
|
| + "description": "Request message for `TestIamPermissions` method.",
|
| + "id": "TestIamPermissionsRequest",
|
| "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.",
|
| + "permissions": {
|
| + "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",
|
| "items": {
|
| - "items": {
|
| - "type": "any"
|
| - },
|
| - "type": "array"
|
| + "type": "string"
|
| },
|
| "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",
|
| + "CommitResponse": {
|
| + "description": "The response for Commit.",
|
| + "id": "CommitResponse",
|
| "properties": {
|
| - "statements": {
|
| - "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "commitTimestamp": {
|
| + "description": "The Cloud Spanner timestamp at which the transaction committed.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Database": {
|
| - "description": "A Cloud Spanner database.",
|
| - "id": "Database",
|
| + "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": {
|
| - "state": {
|
| - "description": "Output only. The current database state.",
|
| + "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"
|
| },
|
| - "ListDatabasesResponse": {
|
| - "description": "The response for ListDatabases.",
|
| - "id": "ListDatabasesResponse",
|
| + "PlanNode": {
|
| + "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
|
| + "id": "PlanNode",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.",
|
| + "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"
|
| },
|
| - "databases": {
|
| - "description": "Databases that matched the request.",
|
| - "items": {
|
| - "$ref": "Database"
|
| + "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": {
|
| + "description": "Properties of the object.",
|
| + "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"
|
| + },
|
| + "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."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SetIamPolicyRequest": {
|
| - "description": "Request message for `SetIamPolicy` method.",
|
| - "id": "SetIamPolicyRequest",
|
| + "AuditConfig": {
|
| + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\nExample Policy with multiple AuditConfigs:\n{\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice@googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n}\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
| + "id": "AuditConfig",
|
| "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",
|
| + "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"
|
| },
|
| - "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."
|
| + "auditLogConfigs": {
|
| + "description": "The configuration for logging of each type of permission.\nNext ID: 4",
|
| + "items": {
|
| + "$ref": "AuditLogConfig"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "exemptedMembers": {
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Instance": {
|
| - "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
|
| - "id": "Instance",
|
| + "CreateInstanceMetadata": {
|
| + "description": "Metadata type for the operation returned by\nCreateInstance.",
|
| + "id": "CreateInstanceMetadata",
|
| "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.",
|
| + "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"
|
| },
|
| - "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"
|
| + "instance": {
|
| + "$ref": "Instance",
|
| + "description": "The instance being created."
|
| },
|
| - "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.",
|
| + "startTime": {
|
| + "description": "The time at which the\nCreateInstance request was\nreceived.",
|
| + "format": "google-datetime",
|
| "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",
|
| + "ChildLink": {
|
| + "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
|
| + "id": "ChildLink",
|
| "properties": {
|
| - "transactionId": {
|
| - "description": "Required. The transaction to roll back.",
|
| - "format": "byte",
|
| + "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"
|
| + },
|
| + "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"
|
| },
|
| - "Transaction": {
|
| - "description": "A transaction.",
|
| - "id": "Transaction",
|
| + "CloudAuditOptions": {
|
| + "description": "Write a Cloud Audit log",
|
| + "id": "CloudAuditOptions",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "Delete": {
|
| + "description": "Arguments to delete operations.",
|
| + "id": "Delete",
|
| "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",
|
| + "table": {
|
| + "description": "Required. The table whose rows will be deleted.",
|
| "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"
|
| + "keySet": {
|
| + "$ref": "KeySet",
|
| + "description": "Required. The primary keys of the rows within table to delete."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "UpdateDatabaseDdlMetadata": {
|
| - "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
|
| - "id": "UpdateDatabaseDdlMetadata",
|
| + "ListInstanceConfigsResponse": {
|
| + "description": "The response for ListInstanceConfigs.",
|
| + "id": "ListInstanceConfigsResponse",
|
| "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"
|
| + "nextPageToken": {
|
| + "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
|
| + "type": "string"
|
| },
|
| - "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]`.",
|
| + "instanceConfigs": {
|
| + "description": "The list of requested instance configurations.",
|
| "items": {
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "$ref": "InstanceConfig"
|
| },
|
| "type": "array"
|
| - },
|
| - "database": {
|
| - "description": "The database being modified.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CounterOptions": {
|
| - "description": "Options for counters",
|
| - "id": "CounterOptions",
|
| + "BeginTransactionRequest": {
|
| + "description": "The request for BeginTransaction.",
|
| + "id": "BeginTransactionRequest",
|
| "properties": {
|
| - "metric": {
|
| - "description": "The metric to update.",
|
| - "type": "string"
|
| - },
|
| - "field": {
|
| - "description": "The field value to attribute.",
|
| - "type": "string"
|
| + "options": {
|
| + "$ref": "TransactionOptions",
|
| + "description": "Required. Options for the new transaction."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "QueryPlan": {
|
| - "description": "Contains an ordered list of nodes appearing in the query plan.",
|
| - "id": "QueryPlan",
|
| + "CommitRequest": {
|
| + "description": "The request for Commit.",
|
| + "id": "CommitRequest",
|
| "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`.",
|
| + "transactionId": {
|
| + "description": "Commit a previously-started transaction.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "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": "PlanNode"
|
| + "$ref": "Mutation"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "StructType": {
|
| - "description": "`StructType` defines the fields of a STRUCT type.",
|
| - "id": "StructType",
|
| + "GetIamPolicyRequest": {
|
| + "description": "Request message for `GetIamPolicy` method.",
|
| + "id": "GetIamPolicyRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "TestIamPermissionsResponse": {
|
| + "description": "Response message for `TestIamPermissions` method.",
|
| + "id": "TestIamPermissionsResponse",
|
| "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.",
|
| + "permissions": {
|
| + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
| "items": {
|
| - "$ref": "Field"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Field": {
|
| - "description": "Message representing a single field of a struct.",
|
| - "id": "Field",
|
| - "properties": {
|
| - "type": {
|
| - "$ref": "Type",
|
| - "description": "The type of the field."
|
| - },
|
| - "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",
|
| + "Rule": {
|
| + "description": "A rule to be applied in a Policy.",
|
| + "id": "Rule",
|
| "properties": {
|
| - "queryPlan": {
|
| - "$ref": "QueryPlan",
|
| - "description": "QueryPlan for the query associated with this result."
|
| + "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"
|
| },
|
| - "queryStats": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| + "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"
|
| },
|
| - "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"
|
| - },
|
| - "TestIamPermissionsRequest": {
|
| - "description": "Request message for `TestIamPermissions` method.",
|
| - "id": "TestIamPermissionsRequest",
|
| - "properties": {
|
| - "permissions": {
|
| - "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",
|
| + "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"
|
| + },
|
| + "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"
|
| },
|
| @@ -2192,374 +2173,394 @@
|
| },
|
| "type": "object"
|
| },
|
| - "CommitResponse": {
|
| - "description": "The response for Commit.",
|
| - "id": "CommitResponse",
|
| + "CreateDatabaseMetadata": {
|
| + "description": "Metadata type for the operation returned by\nCreateDatabase.",
|
| + "id": "CreateDatabaseMetadata",
|
| "properties": {
|
| - "commitTimestamp": {
|
| - "description": "The Cloud Spanner timestamp at which the transaction committed.",
|
| - "format": "google-datetime",
|
| + "database": {
|
| + "description": "The database being created.",
|
| "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",
|
| + "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": {
|
| - "arrayElementType": {
|
| - "$ref": "Type",
|
| - "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
|
| + "dataAccess": {
|
| + "$ref": "DataAccessOptions",
|
| + "description": "Data access options."
|
| },
|
| - "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"
|
| + "cloudAudit": {
|
| + "$ref": "CloudAuditOptions",
|
| + "description": "Cloud audit options."
|
| },
|
| - "structType": {
|
| - "$ref": "StructType",
|
| - "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."
|
| + "counter": {
|
| + "$ref": "CounterOptions",
|
| + "description": "Counter options."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "PlanNode": {
|
| - "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
|
| - "id": "PlanNode",
|
| + "Session": {
|
| + "description": "A session in the Cloud Spanner API.",
|
| + "id": "Session",
|
| "properties": {
|
| - "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.",
|
| + "name": {
|
| + "description": "Required. The name of the session.",
|
| "type": "string"
|
| - },
|
| - "childLinks": {
|
| - "description": "List of child node `index`es and their relationship to this parent.",
|
| + }
|
| + },
|
| + "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": {
|
| - "$ref": "ChildLink"
|
| + "type": "any"
|
| },
|
| "type": "array"
|
| },
|
| - "metadata": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| + "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"
|
| },
|
| - "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.",
|
| + "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": "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."
|
| + "type": "array"
|
| },
|
| - "index": {
|
| - "description": "The `PlanNode`'s index in node list.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "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"
|
| },
|
| - "CreateInstanceMetadata": {
|
| - "description": "Metadata type for the operation returned by\nCreateInstance.",
|
| - "id": "CreateInstanceMetadata",
|
| + "ListInstancesResponse": {
|
| + "description": "The response for ListInstances.",
|
| + "id": "ListInstancesResponse",
|
| "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"
|
| - },
|
| - "endTime": {
|
| - "description": "The time at which this operation failed or was completed successfully.",
|
| - "format": "google-datetime",
|
| + "nextPageToken": {
|
| + "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
|
| "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"
|
| + "instances": {
|
| + "description": "The list of requested instances.",
|
| + "items": {
|
| + "$ref": "Instance"
|
| + },
|
| + "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": {
|
| - "auditLogConfigs": {
|
| - "description": "The configuration for logging of each type of permission.\nNext ID: 4",
|
| - "items": {
|
| - "$ref": "AuditLogConfig"
|
| - },
|
| - "type": "array"
|
| + "description": {
|
| + "description": "A string representation of the expression subtree rooted at this node.",
|
| + "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"
|
| + "subqueries": {
|
| + "additionalProperties": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "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.",
|
| - "type": "string"
|
| + "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"
|
| },
|
| - "ChildLink": {
|
| - "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
|
| - "id": "ChildLink",
|
| + "InstanceConfig": {
|
| + "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",
|
| + "id": "InstanceConfig",
|
| "properties": {
|
| - "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.",
|
| + "name": {
|
| + "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/<project>/instanceConfigs/a-z*`",
|
| "type": "string"
|
| },
|
| - "childIndex": {
|
| - "description": "The node to which the link points.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "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."
|
| },
|
| - "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.",
|
| + "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."
|
| + "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."
|
| - },
|
| - "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",
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "BeginTransactionRequest": {
|
| - "description": "The request for BeginTransaction.",
|
| - "id": "BeginTransactionRequest",
|
| + "CreateInstanceRequest": {
|
| + "description": "The request for CreateInstance.",
|
| + "id": "CreateInstanceRequest",
|
| "properties": {
|
| - "options": {
|
| - "$ref": "TransactionOptions",
|
| - "description": "Required. Options for the new transaction."
|
| + "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>`."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListInstanceConfigsResponse": {
|
| - "description": "The response for ListInstanceConfigs.",
|
| - "id": "ListInstanceConfigsResponse",
|
| + "Condition": {
|
| + "description": "A condition to be met.",
|
| + "id": "Condition",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
|
| + "op": {
|
| + "description": "An operator to apply the subject with.",
|
| + "enum": [
|
| + "NO_OP",
|
| + "EQUALS",
|
| + "NOT_EQUALS",
|
| + "IN",
|
| + "NOT_IN",
|
| + "DISCHARGED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Default no-op.",
|
| + "DEPRECATED. Use IN instead.",
|
| + "DEPRECATED. Use NOT_IN instead.",
|
| + "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
|
| + "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
|
| + "Subject is discharged"
|
| + ],
|
| "type": "string"
|
| },
|
| - "instanceConfigs": {
|
| - "description": "The list of requested instance configurations.",
|
| + "svc": {
|
| + "description": "Trusted attributes discharged by the service.",
|
| + "type": "string"
|
| + },
|
| + "sys": {
|
| + "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
|
| + "enum": [
|
| + "NO_ATTR",
|
| + "REGION",
|
| + "SERVICE",
|
| + "NAME",
|
| + "IP"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Default non-attribute type",
|
| + "Region of the resource",
|
| + "Service name",
|
| + "Resource name",
|
| + "IP address of the caller"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "value": {
|
| + "description": "DEPRECATED. Use 'values' instead.",
|
| + "type": "string"
|
| + },
|
| + "values": {
|
| + "description": "The objects of the condition. This is mutually exclusive with 'value'.",
|
| "items": {
|
| - "$ref": "InstanceConfig"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "iam": {
|
| + "description": "Trusted attributes supplied by the IAM system.",
|
| + "enum": [
|
| + "NO_ATTR",
|
| + "AUTHORITY",
|
| + "ATTRIBUTION",
|
| + "SECURITY_REALM",
|
| + "APPROVER",
|
| + "JUSTIFICATION_TYPE"
|
| + ],
|
| + "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).",
|
| + "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.",
|
| + "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "GetIamPolicyRequest": {
|
| - "description": "Request message for `GetIamPolicy` method.",
|
| - "id": "GetIamPolicyRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "TestIamPermissionsResponse": {
|
| - "description": "Response message for `TestIamPermissions` method.",
|
| - "id": "TestIamPermissionsResponse",
|
| + "AuditLogConfig": {
|
| + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
| + "id": "AuditLogConfig",
|
| "properties": {
|
| - "permissions": {
|
| - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
| + "exemptedMembers": {
|
| + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CreateDatabaseMetadata": {
|
| - "description": "Metadata type for the operation returned by\nCreateDatabase.",
|
| - "id": "CreateDatabaseMetadata",
|
| - "properties": {
|
| - "database": {
|
| - "description": "The database being created.",
|
| + },
|
| + "logType": {
|
| + "description": "The log type that this config enables.",
|
| + "enum": [
|
| + "LOG_TYPE_UNSPECIFIED",
|
| + "ADMIN_READ",
|
| + "DATA_WRITE",
|
| + "DATA_READ"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Default case. Should never be this.",
|
| + "Admin reads. Example: CloudIAM getIamPolicy",
|
| + "Data writes. Example: CloudSQL Users create",
|
| + "Data reads. Example: CloudSQL Users list"
|
| + ],
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Rule": {
|
| - "description": "A rule to be applied in a Policy.",
|
| - "id": "Rule",
|
| + "ReadOnly": {
|
| + "description": "Options for read-only transactions.",
|
| + "id": "ReadOnly",
|
| "properties": {
|
| - "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.",
|
| + "exactStaleness": {
|
| + "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"
|
| },
|
| - "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"
|
| + "strong": {
|
| + "description": "Read at a timestamp where all previously committed transactions\nare visible.",
|
| + "type": "boolean"
|
| },
|
| - "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"
|
| + "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"
|
| },
|
| - "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"
|
| + "maxStaleness": {
|
| + "description": "Read data at a timestamp >= `NOW - max_staleness`\nseconds. Guarantees that all writes that have committed more\nthan the specified number of seconds ago are visible. Because\nCloud Spanner chooses the exact timestamp, this mode works even if\nthe client's local clock is substantially skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshest data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.",
|
| + "format": "google-duration",
|
| + "type": "string"
|
| },
|
| - "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."
|
| - ],
|
| + "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"
|
| }
|
| },
|
| "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",
|
| + "ExecuteSqlRequest": {
|
| + "description": "The request for ExecuteSql and\nExecuteStreamingSql.",
|
| + "id": "ExecuteSqlRequest",
|
| "properties": {
|
| - "dataAccess": {
|
| - "$ref": "DataAccessOptions",
|
| - "description": "Data access options."
|
| + "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"
|
| },
|
| - "cloudAudit": {
|
| - "$ref": "CloudAuditOptions",
|
| - "description": "Cloud audit options."
|
| + "transaction": {
|
| + "$ref": "TransactionSelector",
|
| + "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
|
| },
|
| - "counter": {
|
| - "$ref": "CounterOptions",
|
| - "description": "Counter options."
|
| + "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"
|
| + },
|
| + "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
|
| + "type": "object"
|
| + },
|
| + "sql": {
|
| + "description": "Required. The SQL query string.",
|
| + "type": "string"
|
| + },
|
| + "params": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
|
|
Chromium Code Reviews
Issue 2824163002:
Api-roll 48: 2017-04-18 (Closed)
