openapi: 3.0.0 servers: - url: https://spanner.googleapis.com/ x-hasEquivalentPaths: true info: contact: name: Google url: https://google.com x-twitter: youtube description: Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. license: name: Creative Commons Attribution 3.0 url: http://creativecommons.org/licenses/by/3.0/ termsOfService: https://developers.google.com/terms/ title: Cloud Spanner API version: v1 x-apiClientRegistration: url: https://console.developers.google.com x-apisguru-categories: - analytics - media x-logo: url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png x-origin: - converter: url: https://github.com/mermade/oas-kit version: 7.0.4 format: google url: https://spanner.googleapis.com/$discovery/rest?version=v1 version: v1 x-providerName: googleapis.com x-serviceName: spanner externalDocs: url: https://cloud.google.com/spanner/ tags: - name: projects - name: scans paths: /v1/{database}: delete: description: "Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted." operationId: spanner.projects.instances.databases.dropDatabase parameters: - description: Required. The database to be dropped. in: path name: database required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/Empty" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" /v1/{database}/ddl: get: description: Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API. operationId: spanner.projects.instances.databases.getDdl parameters: - description: Required. The database whose schema we wish to get. Values are of the form `projects//instances//databases/` in: path name: database required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetDatabaseDdlResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" patch: description: Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response. operationId: spanner.projects.instances.databases.updateDdl parameters: - description: Required. The database to update. in: path name: database required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateDatabaseDdlRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{database}/sessions: get: description: Lists all sessions in a given database. operationId: spanner.projects.instances.databases.sessions.list parameters: - description: Required. The database in which to list sessions. in: path name: database required: true schema: type: string - description: 'An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `labels.key` where key is the name of a label Some examples of using filters are: * `labels.env:*` --> The session has the label "env". * `labels.env:dev` --> The session has the label "env" and the value of the label contains the string "dev".' in: query name: filter schema: type: string - description: Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListSessionsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. operationId: spanner.projects.instances.databases.sessions.create parameters: - description: Required. The database in which the new session is created. in: path name: database required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateSessionRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Session" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{database}/sessions:batchCreate: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. operationId: spanner.projects.instances.databases.sessions.batchCreate parameters: - description: Required. The database in which the new sessions are created. in: path name: database required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/BatchCreateSessionsRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/BatchCreateSessionsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{name}: delete: description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. operationId: spanner.projects.instances.operations.delete parameters: - description: The name of the operation resource to be deleted. in: path name: name required: true schema: type: string - description: Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config. in: query name: etag schema: type: string - description: An option to validate, but not actually execute, a request, and provide the same response. in: query name: validateOnly schema: type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/Empty" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects get: description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: spanner.projects.instances.operations.list parameters: - description: The name of the operation's parent resource. in: path name: name required: true schema: type: string - description: The standard list filter. in: query name: filter schema: type: string - description: The standard list page size. in: query name: pageSize schema: type: integer - description: The standard list page token. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListOperationsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" patch: description: "Updates a Cloud Spanner database. The returned long-running operation can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`. While the operation is pending: * The database's reconciling field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's cancel_time is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values. Upon completion of the returned operation: * The new values are in effect and readable via the API. * The database's reconciling field becomes false. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track the database modification. The metadata field type is UpdateDatabaseMetadata. The response field type is Database, if successful." operationId: spanner.projects.instances.databases.patch parameters: - description: Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. in: path name: name required: true schema: type: string - description: Required. The list of fields to update. Currently, only `enable_drop_protection` field can be updated. in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Database" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{name}/scans: get: description: Request a specific scan with Database-specific data for Cloud Key Visualizer. operationId: spanner.projects.instances.databases.getScans parameters: - description: Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface. in: path name: name required: true schema: type: string - description: The upper bound for the time range to retrieve Scan data for. in: query name: endTime schema: type: string - description: These fields restrict the Database-specific information returned in the `Scan.data` field. If a `View` is provided that does not include the `Scan.data` field, these are ignored. This range of time must be entirely contained within the defined time range of the targeted scan. The lower bound for the time range to retrieve Scan data for. in: query name: startTime schema: type: string - description: Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed. in: query name: view schema: enum: - VIEW_UNSPECIFIED - SUMMARY - FULL type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/Scan" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" /v1/{name}:cancel: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. operationId: spanner.projects.instances.operations.cancel parameters: - description: The name of the operation resource to be cancelled. in: path name: name required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/Empty" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{parent}: get: description: Return available scans given a Database-specific resource name. operationId: spanner.scans.list parameters: - description: Required. The unique name of the parent resource, specific to the Database service implementing this interface. in: path name: parent required: true schema: type: string - description: A filter expression to restrict the results based on information present in the available Scan collection. The filter applies to all fields within the Scan message except for `data`. in: query name: filter schema: type: string - description: The maximum number of items to return. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from a previous List request, if any. in: query name: pageToken schema: type: string - description: Specifies which parts of the Scan should be returned in the response. Note, only the SUMMARY view (the default) is currently supported for ListScans. in: query name: view schema: enum: - VIEW_UNSPECIFIED - SUMMARY - FULL type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListScansResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - scans parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" /v1/{parent}/backupOperations: get: description: Lists the backup long-running operations in the given instance. A backup operation has a name of the form `projects//instances//backups//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation. operationId: spanner.projects.instances.backupOperations.list parameters: - description: Required. The instance of the backup operations. Values are of the form `projects//instances/`. in: path name: parent required: true schema: type: string - description: "An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string \"prod\". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.name:howl) AND` \\ `(metadata.progress.start_time < \\\"2018-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string \"howl\". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test) AND` \\ `(metadata.progress.start_time < \\\"2022-01-18T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string \"test\". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.database:test_db)) OR` \\ `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test_bkp)) AND` \\ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string \"test_db\" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string \"test_bkp\" * The operation resulted in an error." in: query name: filter schema: type: string - description: Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListBackupOperationsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" /v1/{parent}/backups: get: description: Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. operationId: spanner.projects.instances.backups.list parameters: - description: Required. The instance to list backups from. Values are of the form `projects//instances/`. in: path name: parent required: true schema: type: string - description: "An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string \"howl\". * `database:prod` - The database's name contains the string \"prod\". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \\\"2018-03-28T14:50:00Z\\\")` - The backup name contains the string \"howl\" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \\\"2018-03-28T14:50:00Z\\\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB" in: query name: filter schema: type: string - description: Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListBackupsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently. operationId: spanner.projects.instances.backups.create parameters: - description: Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`. in: path name: parent required: true schema: type: string - description: Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`. in: query name: backupId schema: type: string - description: Required. The encryption type of the backup. in: query name: encryptionConfig.encryptionType schema: enum: - ENCRYPTION_TYPE_UNSPECIFIED - USE_DATABASE_ENCRYPTION - GOOGLE_DEFAULT_ENCRYPTION - CUSTOMER_MANAGED_ENCRYPTION type: string - description: Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. in: query name: encryptionConfig.kmsKeyName schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Backup" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{parent}/backups:copy: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Starts copying a Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track copying of the backup. The operation is associated with the destination backup. The metadata field type is CopyBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the copying and delete the destination backup. Concurrent CopyBackup requests can run on the same source backup. operationId: spanner.projects.instances.backups.copy parameters: - description: "Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`." in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CopyBackupRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{parent}/databaseOperations: get: description: Lists database longrunning-operations. A database operation has a name of the form `projects//instances//databases//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. operationId: spanner.projects.instances.databaseOperations.list parameters: - description: Required. The instance of the database operations. Values are of the form `projects//instances/`. in: path name: parent required: true schema: type: string - description: "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for RestoreDatabaseMetadata is `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \\ `(metadata.source_type:BACKUP) AND` \\ `(metadata.backup_info.backup:backup_howl) AND` \\ `(metadata.name:restored_howl) AND` \\ `(metadata.progress.start_time < \\\"2018-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is RestoreDatabaseMetadata. * The database is restored from a backup. * The backup name contains \"backup_howl\". * The restored database's name contains \"restored_howl\". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error." in: query name: filter schema: type: string - description: Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same `parent` and with the same `filter`. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListDatabaseOperationsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" /v1/{parent}/databaseRoles: get: description: Lists Cloud Spanner database roles. operationId: spanner.projects.instances.databases.databaseRoles.list parameters: - description: Required. The database whose roles should be listed. Values are of the form `projects//instances//databases/`. in: path name: parent required: true schema: type: string - description: Number of database roles to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListDatabaseRolesResponse. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListDatabaseRolesResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" /v1/{parent}/databases: get: description: Lists Cloud Spanner databases. operationId: spanner.projects.instances.databases.list parameters: - description: Required. The instance whose databases should be listed. Values are of the form `projects//instances/`. in: path name: parent required: true schema: type: string - description: Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListDatabasesResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. operationId: spanner.projects.instances.databases.create parameters: - description: Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateDatabaseRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{parent}/databases:restore: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format `projects//instances//databases//operations/`, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete. operationId: spanner.projects.instances.databases.restore parameters: - description: Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects//instances/`. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/RestoreDatabaseRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{parent}/instanceConfigOperations: get: description: Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation. operationId: spanner.projects.instanceConfigOperations.list parameters: - description: Required. The project of the instance config operations. Values are of the form `projects/`. in: path name: parent required: true schema: type: string - description: "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error." in: query name: filter schema: type: string - description: Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same `parent` and with the same `filter`. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListInstanceConfigOperationsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" /v1/{parent}/instanceConfigs: get: description: Lists the supported instance configurations for a given project. operationId: spanner.projects.instanceConfigs.list parameters: - description: Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. in: path name: parent required: true schema: type: string - description: Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListInstanceConfigsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: "Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent." operationId: spanner.projects.instanceConfigs.create parameters: - description: Required. The name of the project in which to create the instance config. Values are of the form `projects/`. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateInstanceConfigRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{parent}/instances: get: description: Lists all instances in the given project. operationId: spanner.projects.instances.list parameters: - description: Required. The name of the project for which a list of instances is requested. Values are of the form `projects/`. in: path name: parent required: true schema: type: string - description: "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `display_name` * `labels.key` where key is the name of a label Some examples of using filters are: * `name:*` --> The instance has a name. * `name:Howl` --> The instance's name contains the string \"howl\". * `name:HOWL` --> Equivalent to above. * `NAME:howl` --> Equivalent to above. * `labels.env:*` --> The instance has the label \"env\". * `labels.env:dev` --> The instance has the label \"env\" and the value of the label contains the string \"dev\". * `name:howl labels.env:dev` --> The instance's name contains \"howl\" and it has the label \"env\" with its value containing \"dev\"." in: query name: filter schema: type: string - description: Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse. in: query name: instanceDeadline schema: type: string - description: Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. in: query name: pageSize schema: type: integer - description: If non-empty, `page_token` should contain a next_page_token from a previous ListInstancesResponse. in: query name: pageToken schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListInstancesResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: "Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful." operationId: spanner.projects.instances.create parameters: - description: Required. The name of the project in which to create the instance. Values are of the form `projects/`. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateInstanceRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Operation" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{resource}:getIamPolicy: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. operationId: spanner.projects.instances.databases.getIamPolicy parameters: - description: "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources." in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/GetIamPolicyRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Policy" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{resource}:setIamPolicy: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. operationId: spanner.projects.instances.databases.setIamPolicy parameters: - description: "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources." in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/SetIamPolicyRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Policy" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{resource}:testIamPermissions: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. operationId: spanner.projects.instances.databases.databaseRoles.testIamPermissions parameters: - description: "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources." in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/TestIamPermissionsRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/TestIamPermissionsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.admin Oauth2c: - https://www.googleapis.com/auth/spanner.admin tags: - projects /v1/{session}:batchWrite: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue. operationId: spanner.projects.instances.databases.sessions.batchWrite parameters: - description: Required. The session in which the batch request is to be run. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/BatchWriteRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/BatchWriteResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:beginTransaction: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: "Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect." operationId: spanner.projects.instances.databases.sessions.beginTransaction parameters: - description: Required. The session in which the transaction runs. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/BeginTransactionRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Transaction" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:commit: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now. operationId: spanner.projects.instances.databases.sessions.commit parameters: - description: Required. The session in which the transaction to be committed is running. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CommitRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CommitResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:executeBatchDml: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed. operationId: spanner.projects.instances.databases.sessions.executeBatchDml parameters: - description: Required. The session in which the DML statements should be performed. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ExecuteBatchDmlRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ExecuteBatchDmlResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:executeSql: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. operationId: spanner.projects.instances.databases.sessions.executeSql parameters: - description: Required. The session in which the SQL query should be performed. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ExecuteSqlRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResultSet" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:executeStreamingSql: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. operationId: spanner.projects.instances.databases.sessions.executeStreamingSql parameters: - description: Required. The session in which the SQL query should be performed. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ExecuteSqlRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PartialResultSet" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:partitionQuery: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning. operationId: spanner.projects.instances.databases.sessions.partitionQuery parameters: - description: Required. The session used to create the partitions. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PartitionQueryRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PartitionResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:partitionRead: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning. operationId: spanner.projects.instances.databases.sessions.partitionRead parameters: - description: Required. The session used to create the partitions. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PartitionReadRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PartitionResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:read: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. operationId: spanner.projects.instances.databases.sessions.read parameters: - description: Required. The session in which the read should be performed. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ReadRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResultSet" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:rollback: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. operationId: spanner.projects.instances.databases.sessions.rollback parameters: - description: Required. The session in which the transaction to roll back is running. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/RollbackRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Empty" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects /v1/{session}:streamingRead: parameters: - $ref: "#/components/parameters/_.xgafv" - $ref: "#/components/parameters/access_token" - $ref: "#/components/parameters/alt" - $ref: "#/components/parameters/callback" - $ref: "#/components/parameters/fields" - $ref: "#/components/parameters/key" - $ref: "#/components/parameters/oauth_token" - $ref: "#/components/parameters/prettyPrint" - $ref: "#/components/parameters/quotaUser" - $ref: "#/components/parameters/upload_protocol" - $ref: "#/components/parameters/uploadType" post: description: Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. operationId: spanner.projects.instances.databases.sessions.streamingRead parameters: - description: Required. The session in which the read should be performed. in: path name: session required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ReadRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PartialResultSet" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - https://www.googleapis.com/auth/spanner.data Oauth2c: - https://www.googleapis.com/auth/spanner.data tags: - projects components: parameters: _.xgafv: description: V1 error format. in: query name: $.xgafv schema: enum: - "1" - "2" type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string alt: description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string callback: description: JSONP in: query name: callback schema: type: string fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string key: description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean quotaUser: description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string schemas: AutoscalingConfig: description: Autoscaling config for an instance. properties: autoscalingLimits: $ref: "#/components/schemas/AutoscalingLimits" description: Required. Autoscaling limits for an instance. autoscalingTargets: $ref: "#/components/schemas/AutoscalingTargets" description: Required. The autoscaling targets for an instance. type: object AutoscalingLimits: description: The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. properties: maxNodes: description: Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. format: int32 type: integer maxProcessingUnits: description: Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. format: int32 type: integer minNodes: description: Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1. format: int32 type: integer minProcessingUnits: description: Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000. format: int32 type: integer type: object AutoscalingTargets: description: The autoscaling targets for an instance. properties: highPriorityCpuUtilizationPercent: description: Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. format: int32 type: integer storageUtilizationPercent: description: Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 99] inclusive. format: int32 type: integer type: object Backup: description: A backup of a Cloud Spanner database. properties: createTime: description: Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. format: google-datetime readOnly: true type: string database: description: Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. type: string databaseDialect: description: Output only. The database dialect information for the backup. enum: - DATABASE_DIALECT_UNSPECIFIED - GOOGLE_STANDARD_SQL - POSTGRESQL readOnly: true type: string encryptionInfo: $ref: "#/components/schemas/EncryptionInfo" description: Output only. The encryption information for the backup. readOnly: true expireTime: description: Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. format: google-datetime type: string maxExpireTime: description: "Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`." format: google-datetime readOnly: true type: string name: description: Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. type: string referencingBackups: description: Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. items: type: string readOnly: true type: array referencingDatabases: description: Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. items: type: string readOnly: true type: array sizeBytes: description: Output only. Size of the backup in bytes. format: int64 readOnly: true type: string state: description: Output only. The current state of the backup. enum: - STATE_UNSPECIFIED - CREATING - READY readOnly: true type: string versionTime: description: The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. format: google-datetime type: string type: object BackupInfo: description: Information about a backup. properties: backup: description: Name of the backup. type: string createTime: description: The time the CreateBackup request was received. format: google-datetime type: string sourceDatabase: description: Name of the database the backup was created from. type: string versionTime: description: The backup contains an externally consistent copy of `source_database` at the timestamp specified by `version_time`. If the CreateBackup request did not specify `version_time`, the `version_time` of the backup is equivalent to the `create_time`. format: google-datetime type: string type: object BatchCreateSessionsRequest: description: The request for BatchCreateSessions. properties: sessionCount: description: Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary). format: int32 type: integer sessionTemplate: $ref: "#/components/schemas/Session" description: Parameters to be applied to each created session. type: object BatchCreateSessionsResponse: description: The response for BatchCreateSessions. properties: session: description: The freshly created sessions. items: $ref: "#/components/schemas/Session" type: array type: object BatchWriteRequest: description: The request for BatchWrite. properties: mutationGroups: description: Required. The groups of mutations to be applied. items: $ref: "#/components/schemas/MutationGroup" type: array requestOptions: $ref: "#/components/schemas/RequestOptions" description: Common options for this request. type: object BatchWriteResponse: description: The result of applying a batch of mutations. properties: commitTimestamp: description: The commit timestamp of the transaction that applied this batch. Present if `status` is `OK`, absent otherwise. format: google-datetime type: string indexes: description: The mutation groups applied in this batch. The values index into the `mutation_groups` field in the corresponding `BatchWriteRequest`. items: format: int32 type: integer type: array status: $ref: "#/components/schemas/Status" description: An `OK` status indicates success. Any other status indicates a failure. type: object BeginTransactionRequest: description: The request for BeginTransaction. properties: options: $ref: "#/components/schemas/TransactionOptions" description: Required. Options for the new transaction. requestOptions: $ref: "#/components/schemas/RequestOptions" description: Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. type: object Binding: description: Associates `members`, or principals, with a `role`. properties: condition: $ref: "#/components/schemas/Expr" description: The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). members: description: "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`." items: type: string type: array role: description: Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). type: string type: object ChildLink: description: Metadata associated with a parent-child relationship appearing in a PlanNode. properties: childIndex: description: The node to which the link points. format: int32 type: integer type: description: The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable. type: string variable: description: Only present if the child node is SCALAR and corresponds to an output variable of the parent node. The field carries the name of the output variable. For example, a `TableScan` operator that reads rows from a table will have child links to the `SCALAR` nodes representing the output variables created for each column that is read by the operator. The corresponding `variable` fields will be set to the variable names assigned to the columns. type: string type: object CommitRequest: description: The request for Commit. properties: maxCommitDelay: description: Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms. format: google-duration type: string mutations: description: The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. items: $ref: "#/components/schemas/Mutation" type: array requestOptions: $ref: "#/components/schemas/RequestOptions" description: Common options for this request. returnCommitStats: description: If `true`, then statistics related to the transaction will be included in the CommitResponse. Default value is `false`. type: boolean singleUseTransaction: $ref: "#/components/schemas/TransactionOptions" description: Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. transactionId: description: Commit a previously-started transaction. format: byte type: string type: object CommitResponse: description: The response for Commit. properties: commitStats: $ref: "#/components/schemas/CommitStats" description: The statistics about this Commit. Not returned by default. For more information, see CommitRequest.return_commit_stats. commitTimestamp: description: The Cloud Spanner timestamp at which the transaction committed. format: google-datetime type: string type: object CommitStats: description: Additional statistics about a commit. properties: mutationCount: description: The total number of mutations for the transaction. Knowing the `mutation_count` value can help you maximize the number of mutations in a transaction and minimize the number of API round trips. You can also monitor this value to prevent transactions from exceeding the system [limit](https://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data). If the number of mutations exceeds the limit, the server returns [INVALID_ARGUMENT](https://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT). format: int64 type: string type: object ContextValue: description: A message representing context for a KeyRangeInfo, including a label, value, unit, and severity. properties: label: $ref: "#/components/schemas/LocalizedString" description: The label for the context value. e.g. "latency". severity: description: The severity of this context. enum: - SEVERITY_UNSPECIFIED - INFO - WARNING - ERROR - FATAL type: string unit: description: The unit of the context value. type: string value: description: The value for the context. format: float type: number type: object CopyBackupEncryptionConfig: description: Encryption configuration for the copied backup. properties: encryptionType: description: Required. The encryption type of the backup. enum: - ENCRYPTION_TYPE_UNSPECIFIED - USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION - GOOGLE_DEFAULT_ENCRYPTION - CUSTOMER_MANAGED_ENCRYPTION type: string kmsKeyName: description: Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. type: string type: object CopyBackupMetadata: description: Metadata type for the operation returned by CopyBackup. properties: cancelTime: description: The time at which cancellation of CopyBackup operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. format: google-datetime type: string name: description: The name of the backup being created through the copy operation. Values are of the form `projects//instances//backups/`. type: string progress: $ref: "#/components/schemas/OperationProgress" description: The progress of the CopyBackup operation. sourceBackup: description: The name of the source backup that is being copied. Values are of the form `projects//instances//backups/`. type: string type: object CopyBackupRequest: description: The request for CopyBackup. properties: backupId: description: Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects//instances//backups/`. type: string encryptionConfig: $ref: "#/components/schemas/CopyBackupEncryptionConfig" description: Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the source backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. expireTime: description: Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the `create_time` of the source backup. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. format: google-datetime type: string sourceBackup: description: "Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects//instances//backups/`." type: string type: object CreateBackupMetadata: description: Metadata type for the operation returned by CreateBackup. properties: cancelTime: description: The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. format: google-datetime type: string database: description: The name of the database the backup is created from. type: string name: description: The name of the backup being created. type: string progress: $ref: "#/components/schemas/OperationProgress" description: The progress of the CreateBackup operation. type: object CreateDatabaseMetadata: description: Metadata type for the operation returned by CreateDatabase. properties: database: description: The database being created. type: string type: object CreateDatabaseRequest: description: The request for CreateDatabase. properties: createStatement: description: Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `a-z*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``). type: string databaseDialect: description: Optional. The dialect of the Cloud Spanner Database. enum: - DATABASE_DIALECT_UNSPECIFIED - GOOGLE_STANDARD_SQL - POSTGRESQL type: string encryptionConfig: $ref: "#/components/schemas/EncryptionConfig" description: Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption. extraStatements: description: "Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created." items: type: string type: array protoDescriptors: description: Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). format: byte type: string type: object CreateInstanceConfigMetadata: description: Metadata type for the operation returned by CreateInstanceConfig. properties: cancelTime: description: The time at which this operation was cancelled. format: google-datetime type: string instanceConfig: $ref: "#/components/schemas/InstanceConfig" description: The target instance config end state. progress: $ref: "#/components/schemas/InstanceOperationProgress" description: The progress of the CreateInstanceConfig operation. type: object CreateInstanceConfigRequest: description: The request for CreateInstanceConfigRequest. properties: instanceConfig: $ref: "#/components/schemas/InstanceConfig" description: Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. instanceConfigId: description: Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations. type: string validateOnly: description: An option to validate, but not actually execute, a request, and provide the same response. type: boolean type: object CreateInstanceMetadata: description: Metadata type for the operation returned by CreateInstance. properties: cancelTime: description: The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot 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 expectedFulfillmentPeriod: description: The expected fulfillment period of this create operation. enum: - FULFILLMENT_PERIOD_UNSPECIFIED - FULFILLMENT_PERIOD_NORMAL - FULFILLMENT_PERIOD_EXTENDED type: string instance: $ref: "#/components/schemas/Instance" description: The instance being created. startTime: description: The time at which the CreateInstance request was received. format: google-datetime type: string type: object CreateInstanceRequest: description: The request for CreateInstance. properties: instance: $ref: "#/components/schemas/Instance" description: Required. The instance to create. The name may be omitted, but if specified must be `/instances/`. instanceId: description: Required. The ID of the instance to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. type: string type: object CreateSessionRequest: description: The request for CreateSession. properties: session: $ref: "#/components/schemas/Session" description: Required. The session to create. type: object Database: description: A Cloud Spanner database. properties: createTime: description: Output only. If exists, the time at which the database creation started. format: google-datetime readOnly: true type: string databaseDialect: description: Output only. The dialect of the Cloud Spanner Database. enum: - DATABASE_DIALECT_UNSPECIFIED - GOOGLE_STANDARD_SQL - POSTGRESQL readOnly: true type: string defaultLeader: description: Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty. readOnly: true type: string earliestVersionTime: description: Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. format: google-datetime readOnly: true type: string enableDropProtection: description: Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). type: boolean encryptionConfig: $ref: "#/components/schemas/EncryptionConfig" description: Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default or other types of encryption, this field is empty. readOnly: true encryptionInfo: description: Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The `encryption_status' field inside of each `EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field. items: $ref: "#/components/schemas/EncryptionInfo" readOnly: true type: array name: description: Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. type: string reconciling: description: Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. readOnly: true type: boolean restoreInfo: $ref: "#/components/schemas/RestoreInfo" description: Output only. Applicable only for restored databases. Contains information about the restore source. readOnly: true state: description: Output only. The current database state. enum: - STATE_UNSPECIFIED - CREATING - READY - READY_OPTIMIZING readOnly: true type: string versionRetentionPeriod: description: Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set. readOnly: true type: string type: object DatabaseRole: description: A Cloud Spanner database role. properties: name: description: Required. The name of the database role. Values are of the form `projects//instances//databases//databaseRoles/` where `` is as specified in the `CREATE ROLE` DDL statement. type: string type: object DdlStatementActionInfo: description: Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation UpdateDatabaseDdl. properties: action: description: The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string. type: string entityNames: description: The entity name(s) being operated on the DDL statement. E.g. 1. For statement "CREATE TABLE t1(...)", `entity_names` = ["t1"]. 2. For statement "GRANT ROLE r1, r2 ...", `entity_names` = ["r1", "r2"]. 3. For statement "ANALYZE", `entity_names` = []. items: type: string type: array entityType: description: The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, e.g. for statement "ANALYZE", `entity_type` = "". type: string type: object Delete: description: Arguments to delete operations. properties: keySet: $ref: "#/components/schemas/KeySet" description: Required. The primary keys of the rows within table to delete. The primary keys must be specified in the order in which they appear in the `PRIMARY KEY()` clause of the table's equivalent DDL statement (the DDL statement used to create the table). Delete is idempotent. The transaction will succeed even if some or all rows do not exist. table: description: Required. The table whose rows will be deleted. type: string type: object DerivedMetric: description: A message representing a derived metric. properties: denominator: $ref: "#/components/schemas/LocalizedString" description: The name of the denominator metric. e.g. "rows". numerator: $ref: "#/components/schemas/LocalizedString" description: The name of the numerator metric. e.g. "latency". type: object DiagnosticMessage: description: A message representing the key visualizer diagnostic messages. properties: info: $ref: "#/components/schemas/LocalizedString" description: Information about this diagnostic information. metric: $ref: "#/components/schemas/LocalizedString" description: The metric. metricSpecific: description: Whether this message is specific only for the current metric. By default Diagnostics are shown for all metrics, regardless which metric is the currently selected metric in the UI. However occasionally a metric will generate so many messages that the resulting visual clutter becomes overwhelming. In this case setting this to true, will show the diagnostic messages for that metric only if it is the currently selected metric. type: boolean severity: description: The severity of the diagnostic message. enum: - SEVERITY_UNSPECIFIED - INFO - WARNING - ERROR - FATAL type: string shortMessage: $ref: "#/components/schemas/LocalizedString" description: The short message. type: object DirectedReadOptions: description: The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an `INVALID_ARGUMENT` error. properties: excludeReplicas: $ref: "#/components/schemas/ExcludeReplicas" description: Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list. includeReplicas: $ref: "#/components/schemas/IncludeReplicas" description: Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors. type: object Empty: description: "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }" properties: {} type: object EncryptionConfig: description: Encryption configuration for a Cloud Spanner database. properties: kmsKeyName: description: The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. type: string type: object EncryptionInfo: description: Encryption information for a Cloud Spanner database or backup. properties: encryptionStatus: $ref: "#/components/schemas/Status" description: Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest. readOnly: true encryptionType: description: Output only. The type of encryption. enum: - TYPE_UNSPECIFIED - GOOGLE_DEFAULT_ENCRYPTION - CUSTOMER_MANAGED_ENCRYPTION readOnly: true type: string kmsKeyVersion: description: Output only. A Cloud KMS key version that is being used to protect the database or backup. readOnly: true type: string type: object ExcludeReplicas: description: An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests. properties: replicaSelections: description: The directed read replica selector. items: $ref: "#/components/schemas/ReplicaSelection" type: array type: object ExecuteBatchDmlRequest: description: The request for ExecuteBatchDml. properties: requestOptions: $ref: "#/components/schemas/RequestOptions" description: Common options for this request. seqno: description: Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. format: int64 type: string statements: description: Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. items: $ref: "#/components/schemas/Statement" type: array transaction: $ref: "#/components/schemas/TransactionSelector" description: Required. The transaction to use. Must be a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. type: object ExecuteBatchDmlResponse: description: "The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure. To check for DML statements that failed, use the following approach: 1. Check the status in the response message. The google.rpc.Code enum value `OK` indicates that all statements were executed successfully. 2. If the status was not `OK`, check the number of result sets in the response. If the response contains `N` ResultSet messages, then statement `N+1` in the request failed. Example 1: * Request: 5 DML statements, all executed successfully. * Response: 5 ResultSet messages, with the status `OK`. Example 2: * Request: 5 DML statements. The third statement has a syntax error. * Response: 2 ResultSet messages, and a syntax error (`INVALID_ARGUMENT`) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed." properties: resultSets: description: One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata. items: $ref: "#/components/schemas/ResultSet" type: array status: $ref: "#/components/schemas/Status" description: If all DML statements are executed successfully, the status is `OK`. Otherwise, the error status of the first failed statement. type: object ExecuteSqlRequest: description: The request for ExecuteSql and ExecuteStreamingSql. properties: dataBoostEnabled: description: If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error. type: boolean directedReadOptions: $ref: "#/components/schemas/DirectedReadOptions" description: Directed read options for this request. paramTypes: additionalProperties: $ref: "#/components/schemas/Type" description: It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. type: object params: additionalProperties: description: Properties of the object. description: 'Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.' type: object partitionToken: description: If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token. format: byte type: string queryMode: description: Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. enum: - NORMAL - PLAN - PROFILE type: string queryOptions: $ref: "#/components/schemas/QueryOptions" description: Query optimizer configuration to use for the given query. requestOptions: $ref: "#/components/schemas/RequestOptions" description: Common options for this request. resumeToken: description: If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. format: byte type: string seqno: description: A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. format: int64 type: string sql: description: Required. The SQL string. type: string transaction: $ref: "#/components/schemas/TransactionSelector" description: The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID. type: object Expr: description: "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information." properties: description: description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. type: string expression: description: Textual representation of an expression in Common Expression Language syntax. type: string location: description: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. type: string title: description: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. type: string type: object Field: description: Message representing a single field of a struct. properties: name: description: The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. type: string type: $ref: "#/components/schemas/Type" description: The type of the field. type: object FreeInstanceMetadata: description: Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes. properties: expireBehavior: description: Specifies the expiration behavior of a free instance. The default of ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during or after creation, and before expiration. enum: - EXPIRE_BEHAVIOR_UNSPECIFIED - FREE_TO_PROVISIONED - REMOVE_AFTER_GRACE_PERIOD type: string expireTime: description: Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance. format: google-datetime readOnly: true type: string upgradeTime: description: Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance. format: google-datetime readOnly: true type: string type: object GetDatabaseDdlResponse: description: The response for GetDatabaseDdl. properties: protoDescriptors: description: Proto descriptors stored in the database. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). format: byte type: string statements: description: A list of formatted DDL statements defining the schema of the database specified in the request. items: type: string type: array type: object GetIamPolicyRequest: description: Request message for `GetIamPolicy` method. properties: options: $ref: "#/components/schemas/GetPolicyOptions" description: "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." type: object GetPolicyOptions: description: Encapsulates settings provided to GetIamPolicy. properties: requestedPolicyVersion: description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). format: int32 type: integer type: object IncludeReplicas: description: An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered. properties: autoFailoverDisabled: description: If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`. type: boolean replicaSelections: description: The directed read replica selector. items: $ref: "#/components/schemas/ReplicaSelection" type: array type: object IndexAdvice: description: Recommendation to add new indexes to run queries more efficiently. properties: ddl: description: Optional. DDL statements to add new indexes that will improve the query. items: type: string type: array improvementFactor: description: Optional. Estimated latency improvement factor. For example if the query currently takes 500 ms to run and the estimated latency with new indexes is 100 ms this field will be 5. format: double type: number type: object IndexedHotKey: description: A message representing a (sparse) collection of hot keys for specific key buckets. properties: sparseHotKeys: additionalProperties: format: int32 type: integer description: A (sparse) mapping from key bucket index to the index of the specific hot row key for that key bucket. The index of the hot row key can be translated to the actual row key via the ScanData.VisualizationData.indexed_keys repeated field. type: object type: object IndexedKeyRangeInfos: description: A message representing a (sparse) collection of KeyRangeInfos for specific key buckets. properties: keyRangeInfos: additionalProperties: $ref: "#/components/schemas/KeyRangeInfos" description: A (sparse) mapping from key bucket index to the KeyRangeInfos for that key bucket. type: object type: object Instance: description: An isolated set of Cloud Spanner resources on which databases can be hosted. properties: autoscalingConfig: $ref: "#/components/schemas/AutoscalingConfig" description: Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. config: description: Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. type: string createTime: description: Output only. The time at which the instance was created. format: google-datetime readOnly: true type: string displayName: description: Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. type: string endpointUris: description: Deprecated. This field is not populated. items: type: string type: array freeInstanceMetadata: $ref: "#/components/schemas/FreeInstanceMetadata" description: Free instance metadata. Only populated for free instances. instanceType: description: The `InstanceType` of the current instance. enum: - INSTANCE_TYPE_UNSPECIFIED - PROVISIONED - FREE_INSTANCE type: string labels: additionalProperties: type: string description: "Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + \"_\" + value would prove problematic if we were to allow \"_\" in a future release." type: object name: description: Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. type: string nodeCount: description: The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. format: int32 type: integer processingUnits: description: The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. format: int32 type: integer state: description: Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. enum: - STATE_UNSPECIFIED - CREATING - READY readOnly: true type: string updateTime: description: Output only. The time at which the instance was most recently updated. format: google-datetime readOnly: true type: string type: object InstanceConfig: description: A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. properties: baseConfig: description: Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration. type: string configType: description: Output only. Whether this instance config is a Google or User Managed Configuration. enum: - TYPE_UNSPECIFIED - GOOGLE_MANAGED - USER_MANAGED readOnly: true type: string displayName: description: The name of this instance configuration as it appears in UIs. type: string etag: description: "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly." type: string freeInstanceAvailability: description: Output only. Describes whether free instances are available to be created in this instance config. enum: - FREE_INSTANCE_AVAILABILITY_UNSPECIFIED - AVAILABLE - UNSUPPORTED - DISABLED - QUOTA_EXCEEDED readOnly: true type: string labels: additionalProperties: type: string description: "Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + \"_\" + value would prove problematic if we were to allow \"_\" in a future release." type: object leaderOptions: description: Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. items: type: string type: array name: description: A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. type: string optionalReplicas: description: Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. items: $ref: "#/components/schemas/ReplicaInfo" readOnly: true type: array reconciling: description: Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. readOnly: true type: boolean replicas: description: The geographic placement of nodes in this instance configuration and their replication properties. items: $ref: "#/components/schemas/ReplicaInfo" type: array state: description: Output only. The current instance config state. Applicable only for USER_MANAGED configs. enum: - STATE_UNSPECIFIED - CREATING - READY readOnly: true type: string storageLimitPerProcessingUnit: description: Output only. The storage limit in bytes per processing unit. format: int64 readOnly: true type: string type: object InstanceOperationProgress: description: Encapsulates progress related information for a Cloud Spanner long running instance operations. properties: endTime: description: If set, the time at which this operation failed or was completed successfully. format: google-datetime type: string progressPercent: description: Percent completion of the operation. Values are between 0 and 100 inclusive. format: int32 type: integer startTime: description: Time the request was received. format: google-datetime type: string type: object KeyRange: description: "KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: \"Bob\", \"2014-09-23\" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `\"Bob\"` that occurred in the year 2015: \"start_closed\": [\"Bob\", \"2015-01-01\"] \"end_closed\": [\"Bob\", \"2015-12-31\"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `\"Bob\"` that occurred during and after the year 2000: \"start_closed\": [\"Bob\", \"2000-01-01\"] \"end_closed\": [\"Bob\"] The next example retrieves all events for `\"Bob\"`: \"start_closed\": [\"Bob\"] \"end_closed\": [\"Bob\"] To retrieve events before the year 2000: \"start_closed\": [\"Bob\"] \"end_open\": [\"Bob\", \"2000-01-01\"] The following range includes all rows in the table: \"start_closed\": [] \"end_closed\": [] This range returns all users whose `UserName` begins with any character from A to C: \"start_closed\": [\"A\"] \"end_open\": [\"D\"] This range returns all users whose `UserName` begins with B: \"start_closed\": [\"B\"] \"end_open\": [\"C\"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: \"start_closed\": [\"100\"] \"end_closed\": [\"1\"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema." properties: endClosed: description: If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`. items: {} type: array endOpen: description: If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`. items: {} type: array startClosed: description: If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`. items: {} type: array startOpen: description: If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`. items: {} type: array type: object KeyRangeInfo: description: A message representing information for a key range (possibly one key). properties: contextValues: description: The list of context values for this key range. items: $ref: "#/components/schemas/ContextValue" type: array endKeyIndex: description: The index of the end key in indexed_keys. format: int32 type: integer info: $ref: "#/components/schemas/LocalizedString" description: Information about this key range, for all metrics. keysCount: description: The number of keys this range covers. format: int64 type: string metric: $ref: "#/components/schemas/LocalizedString" description: The name of the metric. e.g. "latency". startKeyIndex: description: The index of the start key in indexed_keys. format: int32 type: integer timeOffset: description: The time offset. This is the time since the start of the time interval. format: google-duration type: string unit: $ref: "#/components/schemas/LocalizedString" description: The unit of the metric. This is an unstructured field and will be mapped as is to the user. value: description: The value of the metric. format: float type: number type: object KeyRangeInfos: description: A message representing a list of specific information for multiple key ranges. properties: infos: description: The list individual KeyRangeInfos. items: $ref: "#/components/schemas/KeyRangeInfo" type: array totalSize: description: The total size of the list of all KeyRangeInfos. This may be larger than the number of repeated messages above. If that is the case, this number may be used to determine how many are not being shown. format: int32 type: integer type: object KeySet: description: "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way. If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once." properties: all: description: For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index. Note that any keys specified in `keys` or `ranges` are only yielded once. type: boolean keys: description: A list of specific keys. Entries in `keys` should have exactly as many elements as there are columns in the primary or index key with which this `KeySet` is used. Individual key values are encoded as described here. items: items: {} type: array type: array ranges: description: A list of key ranges. See KeyRange for more information about key range specifications. items: $ref: "#/components/schemas/KeyRange" type: array type: object ListBackupOperationsResponse: description: The response for ListBackupOperations. properties: nextPageToken: description: "`next_page_token` can be sent in a subsequent ListBackupOperations call to fetch more of the matching metadata." type: string operations: description: The list of matching backup long-running operations. Each operation's name will be prefixed by the backup's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that are pending or have completed/failed/canceled within the last 7 days. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation. items: $ref: "#/components/schemas/Operation" type: array type: object ListBackupsResponse: description: The response for ListBackups. properties: backups: description: The list of matching backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. items: $ref: "#/components/schemas/Backup" type: array nextPageToken: description: "`next_page_token` can be sent in a subsequent ListBackups call to fetch more of the matching backups." type: string type: object ListDatabaseOperationsResponse: description: The response for ListDatabaseOperations. properties: nextPageToken: description: "`next_page_token` can be sent in a subsequent ListDatabaseOperations call to fetch more of the matching metadata." type: string operations: description: The list of matching database long-running operations. Each operation's name will be prefixed by the database's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. items: $ref: "#/components/schemas/Operation" type: array type: object ListDatabaseRolesResponse: description: The response for ListDatabaseRoles. properties: databaseRoles: description: Database roles that matched the request. items: $ref: "#/components/schemas/DatabaseRole" type: array nextPageToken: description: "`next_page_token` can be sent in a subsequent ListDatabaseRoles call to fetch more of the matching roles." type: string type: object ListDatabasesResponse: description: The response for ListDatabases. properties: databases: description: Databases that matched the request. items: $ref: "#/components/schemas/Database" type: array nextPageToken: description: "`next_page_token` can be sent in a subsequent ListDatabases call to fetch more of the matching databases." type: string type: object ListInstanceConfigOperationsResponse: description: The response for ListInstanceConfigOperations. properties: nextPageToken: description: "`next_page_token` can be sent in a subsequent ListInstanceConfigOperations call to fetch more of the matching metadata." type: string operations: description: The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. items: $ref: "#/components/schemas/Operation" type: array type: object ListInstanceConfigsResponse: description: The response for ListInstanceConfigs. properties: instanceConfigs: description: The list of requested instance configurations. items: $ref: "#/components/schemas/InstanceConfig" type: array nextPageToken: description: "`next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations." type: string type: object ListInstancesResponse: description: The response for ListInstances. properties: instances: description: The list of requested instances. items: $ref: "#/components/schemas/Instance" type: array nextPageToken: description: "`next_page_token` can be sent in a subsequent ListInstances call to fetch more of the matching instances." type: string unreachable: description: The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline. items: type: string type: array type: object ListOperationsResponse: description: The response message for Operations.ListOperations. properties: nextPageToken: description: The standard List next-page token. type: string operations: description: A list of operations that matches the specified filter in the request. items: $ref: "#/components/schemas/Operation" type: array type: object ListScansResponse: description: Response method from the ListScans method. properties: nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string scans: description: Available scans based on the list query parameters. items: $ref: "#/components/schemas/Scan" type: array type: object ListSessionsResponse: description: The response for ListSessions. properties: nextPageToken: description: "`next_page_token` can be sent in a subsequent ListSessions call to fetch more of the matching sessions." type: string sessions: description: The list of requested sessions. items: $ref: "#/components/schemas/Session" type: array type: object LocalizedString: description: A message representing a user-facing string whose value may need to be translated before being displayed. properties: args: additionalProperties: type: string description: A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values. type: object message: description: The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is. type: string token: description: The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service. type: string type: object Metric: description: A message representing the actual monitoring data, values for each key bucket over time, of a metric. properties: aggregation: description: The aggregation function used to aggregate each key bucket enum: - AGGREGATION_UNSPECIFIED - MAX - SUM type: string category: $ref: "#/components/schemas/LocalizedString" description: The category of the metric, e.g. "Activity", "Alerts", "Reads", etc. derived: $ref: "#/components/schemas/DerivedMetric" description: The references to numerator and denominator metrics for a derived metric. displayLabel: $ref: "#/components/schemas/LocalizedString" description: The displayed label of the metric. hasNonzeroData: description: Whether the metric has any non-zero data. type: boolean hotValue: description: The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user. hot_value is used to calibrate and scale visual color scales. format: float type: number indexedHotKeys: additionalProperties: $ref: "#/components/schemas/IndexedHotKey" description: The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys. type: object indexedKeyRangeInfos: additionalProperties: $ref: "#/components/schemas/IndexedKeyRangeInfos" description: The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges. type: object info: $ref: "#/components/schemas/LocalizedString" description: Information about the metric. matrix: $ref: "#/components/schemas/MetricMatrix" description: The data for the metric as a matrix. unit: $ref: "#/components/schemas/LocalizedString" description: The unit of the metric. visible: description: Whether the metric is visible to the end user. type: boolean type: object MetricMatrix: description: A message representing a matrix of floats. properties: rows: description: The rows of the matrix. items: $ref: "#/components/schemas/MetricMatrixRow" type: array type: object MetricMatrixRow: description: A message representing a row of a matrix of floats. properties: cols: description: The columns of the row. items: format: float type: number type: array type: object Mutation: description: A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call. properties: delete: $ref: "#/components/schemas/Delete" description: Delete rows from a table. Succeeds whether or not the named rows were present. insert: $ref: "#/components/schemas/Write" description: Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error `ALREADY_EXISTS`. insertOrUpdate: $ref: "#/components/schemas/Write" description: Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved. When using insert_or_update, just as when using insert, all `NOT NULL` columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated. replace: $ref: "#/components/schemas/Write" description: Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row. update: $ref: "#/components/schemas/Write" description: Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`. type: object MutationGroup: description: A group of mutations to be committed together. Related mutations should be placed in a group. For example, two mutations inserting rows with the same primary key prefix in both parent and child tables are related. properties: mutations: description: Required. The mutations in this group. items: $ref: "#/components/schemas/Mutation" type: array type: object Operation: description: This resource represents a long-running operation that is the result of a network API call. properties: done: description: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. type: boolean error: $ref: "#/components/schemas/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. description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. type: object name: description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. type: string response: additionalProperties: description: Properties of the object. Contains field @type with type URL. description: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. type: object type: object OperationProgress: description: Encapsulates progress related information for a Cloud Spanner long running operation. properties: endTime: description: If set, the time at which this operation failed or was completed successfully. format: google-datetime type: string progressPercent: description: Percent completion of the operation. Values are between 0 and 100 inclusive. format: int32 type: integer startTime: description: Time the request was received. format: google-datetime type: string type: object OptimizeRestoredDatabaseMetadata: description: Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database. This long-running operation is automatically created by the system after the successful completion of a database restore, and cannot be cancelled. properties: name: description: Name of the restored database being optimized. type: string progress: $ref: "#/components/schemas/OperationProgress" description: The progress of the post-restore optimizations. type: object PartialResultSet: description: Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume. properties: chunkedValue: description: If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value. type: boolean metadata: $ref: "#/components/schemas/ResultSetMetadata" description: Metadata about the result set, such as row type information. Only present in the first response. resumeToken: description: Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token. format: byte type: string stats: $ref: "#/components/schemas/ResultSetStats" description: Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements. values: description: 'A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: cannot be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: # Strings are concatenated. "foo", "bar" => "foobar" # Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are concatenated, but the last and first elements are merged # because they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] # Lists are concatenated, but the last and first elements are merged # because they are lists. Recursively, the last and first elements # of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] # Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} # Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} # Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true } { "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `"resume_token": "Af65..."` will yield results from the `PartialResultSet` with value `["orl"]`.' items: {} type: array type: object Partition: description: Information returned for each partition returned in a PartitionResponse. properties: partitionToken: description: This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token. format: byte type: string type: object PartitionOptions: description: Options for a PartitionQueryRequest and PartitionReadRequest. properties: maxPartitions: description: "**Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request." format: int64 type: string partitionSizeBytes: description: "**Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request." format: int64 type: string type: object PartitionQueryRequest: description: The request for PartitionQuery properties: paramTypes: additionalProperties: $ref: "#/components/schemas/Type" description: It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. type: object params: additionalProperties: description: Properties of the object. description: 'Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.' type: object partitionOptions: $ref: "#/components/schemas/PartitionOptions" description: Additional options that affect how many partitions are created. sql: description: Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. type: string transaction: $ref: "#/components/schemas/TransactionSelector" description: Read only snapshot transactions are supported, read/write and single use transactions are not. type: object PartitionReadRequest: description: The request for PartitionRead properties: columns: description: The columns of table to be returned for each row matching this request. items: type: string type: array index: description: If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. type: string keySet: $ref: "#/components/schemas/KeySet" description: Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. partitionOptions: $ref: "#/components/schemas/PartitionOptions" description: Additional options that affect how many partitions are created. table: description: Required. The name of the table in the database to be read. type: string transaction: $ref: "#/components/schemas/TransactionSelector" description: Read only snapshot transactions are supported, read/write and single use transactions are not. type: object PartitionResponse: description: The response for PartitionQuery or PartitionRead properties: partitions: description: Partitions created by this request. items: $ref: "#/components/schemas/Partition" type: array transaction: $ref: "#/components/schemas/Transaction" description: Transaction created by this request. type: object PartitionedDml: description: Message type to initiate a Partitioned DML transaction. properties: {} type: object PlanNode: description: Node information for nodes appearing in a QueryPlan.plan_nodes. properties: childLinks: description: List of child node `index`es and their relationship to this parent. items: $ref: "#/components/schemas/ChildLink" type: array displayName: description: The display name for the node. type: string executionStats: additionalProperties: description: Properties of the object. description: The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc. type: object 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 different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent. enum: - KIND_UNSPECIFIED - RELATIONAL - SCALAR type: string metadata: additionalProperties: description: Properties of the object. description: 'Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }' type: object shortRepresentation: $ref: "#/components/schemas/ShortRepresentation" description: Condensed representation for SCALAR nodes. type: object Policy: description: "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)." properties: bindings: description: Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. items: $ref: "#/components/schemas/Binding" type: array etag: description: "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost." format: byte type: string version: description: "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." format: int32 type: integer type: object PrefixNode: description: A message representing a key prefix node in the key prefix hierarchy. for eg. Bigtable keyspaces are lexicographically ordered mappings of keys to values. Keys often have a shared prefix structure where users use the keys to organize data. Eg ///employee In this case Keysight will possibly use one node for a company and reuse it for all employees that fall under the company. Doing so improves legibility in the UI. properties: dataSourceNode: description: Whether this corresponds to a data_source name. type: boolean depth: description: The depth in the prefix hierarchy. format: int32 type: integer endIndex: description: The index of the end key bucket of the range that this node spans. format: int32 type: integer startIndex: description: The index of the start key bucket of the range that this node spans. format: int32 type: integer word: description: The string represented by the prefix node. type: string type: object QueryAdvisorResult: description: Output of query advisor analysis. properties: indexAdvice: description: Optional. Index Recommendation for a query. This is an optional field and the recommendation will only be available when the recommendation guarantees significant improvement in query performance. items: $ref: "#/components/schemas/IndexAdvice" type: array type: object QueryOptions: description: Query optimizer configuration. properties: optimizerStatisticsPackage: description: "An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option is not set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an `INVALID_ARGUMENT` error." type: string optimizerVersion: description: An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an invalid optimizer version fails with an `INVALID_ARGUMENT` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has precedence over this setting. type: string type: object QueryPlan: description: Contains an ordered list of nodes appearing in the query plan. properties: planNodes: description: The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's `id` corresponds to its index in `plan_nodes`. items: $ref: "#/components/schemas/PlanNode" type: array queryAdvice: $ref: "#/components/schemas/QueryAdvisorResult" description: Optional. The advices/recommendations for a query. Currently this field will be serving index recommendations for a query. type: object ReadOnly: description: Message type to initiate a read-only transaction. properties: exactStaleness: description: Executes all reads at a timestamp that is `exact_staleness` old. The timestamp is chosen soon after the read is started. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of `max_staleness`. format: google-duration type: string maxStaleness: description: Read data at a timestamp >= `NOW - max_staleness` seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind. Note that this option can only be used in single-use transactions. format: google-duration type: string minReadTimestamp: description: 'Executes all reads at a timestamp >= `min_read_timestamp`. This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known. Note that this option can only be used in single-use transactions. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.' format: google-datetime type: string readTimestamp: description: "Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds. Example: `\"2014-10-02T15:01:23.045123456Z\"`." format: google-datetime type: string returnReadTimestamp: description: If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction. type: boolean strong: description: Read at a timestamp where all previously committed transactions are visible. type: boolean type: object ReadRequest: description: The request for Read and StreamingRead. properties: columns: description: Required. The columns of table to be returned for each row matching this request. items: type: string type: array dataBoostEnabled: description: If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error. type: boolean directedReadOptions: $ref: "#/components/schemas/DirectedReadOptions" description: Directed read options for this request. index: description: If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. type: string keySet: $ref: "#/components/schemas/KeySet" description: Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. limit: description: If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit cannot be specified if `partition_token` is set. format: int64 type: string partitionToken: description: If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. format: byte type: string requestOptions: $ref: "#/components/schemas/RequestOptions" description: Common options for this request. resumeToken: description: If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. format: byte type: string table: description: Required. The name of the table in the database to be read. type: string transaction: $ref: "#/components/schemas/TransactionSelector" description: The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. type: object ReadWrite: description: Message type to initiate a read-write transaction. Currently this transaction type has no options. properties: readLockMode: description: Read lock mode for the transaction. enum: - READ_LOCK_MODE_UNSPECIFIED - PESSIMISTIC - OPTIMISTIC type: string type: object ReplicaInfo: properties: defaultLeaderLocation: description: If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. type: boolean location: description: The location of the serving resources, e.g., "us-central1". type: string type: description: The type of replica. enum: - TYPE_UNSPECIFIED - READ_WRITE - READ_ONLY - WITNESS type: string type: object ReplicaSelection: description: 'The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * `location` - The location must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --> The "us-east1" replica(s) of any available type will be used to process the request. * `type:READ_ONLY` --> The "READ_ONLY" type replica(s) in nearest available location will be used to process the request. * `location:us-east1 type:READ_ONLY` --> The "READ_ONLY" type replica(s) in location "us-east1" will be used to process the request.' properties: location: description: The location or region of the serving requests, e.g. "us-east1". type: string type: description: The type of replica. enum: - TYPE_UNSPECIFIED - READ_WRITE - READ_ONLY type: string type: object RequestOptions: description: Common request options for various APIs. properties: priority: description: Priority for the request. enum: - PRIORITY_UNSPECIFIED - PRIORITY_LOW - PRIORITY_MEDIUM - PRIORITY_HIGH type: string requestTag: description: A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string. type: string transactionTag: description: A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string. type: string type: object RestoreDatabaseEncryptionConfig: description: Encryption configuration for the restored database. properties: encryptionType: description: Required. The encryption type of the restored database. enum: - ENCRYPTION_TYPE_UNSPECIFIED - USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION - GOOGLE_DEFAULT_ENCRYPTION - CUSTOMER_MANAGED_ENCRYPTION type: string kmsKeyName: description: Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. type: string type: object RestoreDatabaseMetadata: description: Metadata type for the long-running operation returned by RestoreDatabase. properties: backupInfo: $ref: "#/components/schemas/BackupInfo" description: Information about the backup used to restore the database. cancelTime: description: The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. format: google-datetime type: string name: description: Name of the database being created and restored to. type: string optimizeDatabaseOperationName: description: If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form `projects//instances//databases//operations/` where the is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful. type: string progress: $ref: "#/components/schemas/OperationProgress" description: The progress of the RestoreDatabase operation. sourceType: description: The type of the restore source. enum: - TYPE_UNSPECIFIED - BACKUP type: string type: object RestoreDatabaseRequest: description: The request for RestoreDatabase. properties: backup: description: Name of the backup from which to restore. Values are of the form `projects//instances//backups/`. type: string databaseId: description: Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects//instances//databases/`. type: string encryptionConfig: $ref: "#/components/schemas/RestoreDatabaseEncryptionConfig" description: Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. type: object RestoreInfo: description: Information about the database restore. properties: backupInfo: $ref: "#/components/schemas/BackupInfo" description: Information about the backup used to restore the database. The backup may no longer exist. sourceType: description: The type of the restore source. enum: - TYPE_UNSPECIFIED - BACKUP type: string type: object ResultSet: description: Results from Read or ExecuteSql. properties: metadata: $ref: "#/components/schemas/ResultSetMetadata" description: Metadata about the result set, such as row type information. rows: description: Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here. items: items: {} type: array type: array stats: $ref: "#/components/schemas/ResultSetStats" description: Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode. type: object ResultSetMetadata: description: Metadata about a ResultSet or PartialResultSet. properties: rowType: $ref: "#/components/schemas/StructType" description: 'Indicates the field names and types for the rows in the result set. For example, a SQL query like `"SELECT UserId, UserName FROM Users"` could return a `row_type` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]' transaction: $ref: "#/components/schemas/Transaction" description: If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here. undeclaredParameters: $ref: "#/components/schemas/StructType" description: 'A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like `"SELECT * FROM Users where UserId = @userId and UserName = @userName "` could return a `undeclared_parameters` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]' type: object ResultSetStats: description: Additional statistics about a ResultSet or PartialResultSet. properties: queryPlan: $ref: "#/components/schemas/QueryPlan" description: QueryPlan for the query associated with this result. queryStats: additionalProperties: description: Properties of the object. description: 'Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }' type: object rowCountExact: description: Standard DML returns an exact count of rows that were modified. format: int64 type: string rowCountLowerBound: description: Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified. format: int64 type: string type: object RollbackRequest: description: The request for Rollback. properties: transactionId: description: Required. The transaction to roll back. format: byte type: string type: object Scan: description: Scan is a structure which describes Cloud Key Visualizer scan information. properties: details: additionalProperties: description: Properties of the object. Contains field @type with type URL. description: Additional information provided by the implementer. type: object endTime: description: The upper bound for when the scan is defined. format: google-datetime type: string name: description: The unique name of the scan, specific to the Database service implementing this interface. type: string scanData: $ref: "#/components/schemas/ScanData" description: Output only. Cloud Key Visualizer scan data. Note, this field is not available to the ListScans method. readOnly: true startTime: description: A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is defined. format: google-datetime type: string type: object ScanData: description: ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization. properties: data: $ref: "#/components/schemas/VisualizationData" description: Cloud Key Visualizer scan data. The range of time this information covers is captured via the above time range fields. Note, this field is not available to the ListScans method. endTime: description: The upper bound for when the contained data is defined. format: google-datetime type: string startTime: description: A range of time (inclusive) for when the contained data is defined. The lower bound for when the contained data is defined. format: google-datetime type: string type: object Session: description: A session in the Cloud Spanner API. properties: approximateLastUseTime: description: Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. format: google-datetime readOnly: true type: string createTime: description: Output only. The timestamp when the session is created. format: google-datetime readOnly: true type: string creatorRole: description: The database role which created this session. type: string labels: additionalProperties: type: string description: "The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels." type: object name: description: Output only. The name of the session. This is always system-assigned. readOnly: true type: string type: object SetIamPolicyRequest: description: Request message for `SetIamPolicy` method. properties: policy: $ref: "#/components/schemas/Policy" description: "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." type: object ShortRepresentation: description: Condensed representation of a node and its subtree. Only present for `SCALAR` PlanNode(s). properties: description: description: A string representation of the expression subtree rooted at this node. type: string subqueries: additionalProperties: format: int32 type: integer description: A mapping of (subquery variable name) -> (subquery node id) for cases where the `description` string of this node references a `SCALAR` subquery contained in the expression subtree rooted at this node. The referenced `SCALAR` subquery may not necessarily be a direct child of this node. type: object type: object Statement: description: A single DML statement. properties: paramTypes: additionalProperties: $ref: "#/components/schemas/Type" description: It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. type: object params: additionalProperties: description: Properties of the object. description: 'Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.' type: object sql: description: Required. The DML string. type: string type: object Status: description: "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." properties: code: description: The status code, which should be an enum value of google.rpc.Code. format: int32 type: integer details: description: A list of messages that carry the error details. There is a common set of message types for APIs to use. items: additionalProperties: description: Properties of the object. Contains field @type with type URL. type: object type: array message: description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type: string type: object StructType: description: "`StructType` defines the fields of a STRUCT type." properties: fields: description: The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. items: $ref: "#/components/schemas/Field" type: array type: object TestIamPermissionsRequest: description: Request message for `TestIamPermissions` method. properties: permissions: description: "REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed." items: type: string type: array type: object TestIamPermissionsResponse: description: Response message for `TestIamPermissions` method. properties: permissions: description: A subset of `TestPermissionsRequest.permissions` that the caller is allowed. items: type: string type: array type: object Transaction: description: A transaction. properties: id: description: "`id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests." format: byte type: string readTimestamp: description: 'For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.' format: google-datetime type: string type: object TransactionOptions: description: "Transactions: Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. Transaction modes: Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. Snapshot read-only transactions provide guaranteed consistency across several reads, but do not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past, or configured to perform a strong read (where Spanner will select a timestamp such that the read is guaranteed to see the effects of all transactions that have committed before the start of the read). Snapshot read-only transactions do not need to be committed. Queries on change streams must be performed with the snapshot read-only transaction mode, specifying a strong read. Please see TransactionOptions.ReadOnly.strong for more details. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read-write data in a single database. They may, however, read-write data in different tables within that database. Locking read-write transactions: Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. Semantics: Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. Retrying aborted transactions: When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (for example, many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of time spent retrying. Idle transactions: A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. If an idle transaction is aborted, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `SELECT 1`) prevents the transaction from becoming idle. Snapshot read-only transactions: Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transactions, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. Strong: Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See TransactionOptions.ReadOnly.strong. Exact staleness: These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp less than or equal to the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a \"negotiation phase\" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. Bounded staleness: Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. Old read timestamps and garbage collection: Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as \"version GC\". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 will be returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table." properties: partitionedDml: $ref: "#/components/schemas/PartitionedDml" description: Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource. readOnly: $ref: "#/components/schemas/ReadOnly" description: Transaction will not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource. readWrite: $ref: "#/components/schemas/ReadWrite" description: Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. type: object TransactionSelector: description: This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions. properties: begin: $ref: "#/components/schemas/TransactionOptions" description: Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in ResultSetMetadata.transaction, which is a Transaction. id: description: Execute the read or SQL query in a previously-started transaction. format: byte type: string singleUse: $ref: "#/components/schemas/TransactionOptions" description: Execute the read or SQL query in a temporary transaction. This is the most efficient way to execute a transaction that consists of a single SQL query. type: object Type: description: "`Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query." properties: arrayElementType: $ref: "#/components/schemas/Type" description: If code == ARRAY, then `array_element_type` is the type of the array elements. code: description: Required. The TypeCode for this type. enum: - TYPE_CODE_UNSPECIFIED - BOOL - INT64 - FLOAT64 - FLOAT32 - TIMESTAMP - DATE - STRING - BYTES - ARRAY - STRUCT - NUMERIC - JSON - PROTO - ENUM type: string protoTypeFqn: description: If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition. type: string structType: $ref: "#/components/schemas/StructType" description: If code == STRUCT, then `struct_type` provides type information for the struct's fields. typeAnnotation: description: The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path. enum: - TYPE_ANNOTATION_CODE_UNSPECIFIED - PG_NUMERIC - PG_JSONB type: string type: object UpdateDatabaseDdlMetadata: description: Metadata type for the operation returned by UpdateDatabaseDdl. properties: actions: description: The brief action info for the DDL statements. `actions[i]` is the brief info for `statements[i]`. items: $ref: "#/components/schemas/DdlStatementActionInfo" type: array commitTimestamps: description: Reports the commit timestamps of all statements that have succeeded so far, where `commit_timestamps[i]` is the commit timestamp for the statement `statements[i]`. items: format: google-datetime type: string type: array database: description: The database being modified. type: string progress: description: The progress of the UpdateDatabaseDdl operations. All DDL statements will have continuously updating progress, and `progress[i]` is the operation progress for `statements[i]`. Also, `progress[i]` will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. items: $ref: "#/components/schemas/OperationProgress" type: array statements: description: For an update this list contains all the statements. For an individual statement, this list contains only that statement. items: type: string type: array throttled: description: Output only. When true, indicates that the operation is throttled e.g. due to resource constraints. When resources become available the operation will resume and this field will be false again. readOnly: true type: boolean type: object UpdateDatabaseDdlRequest: description: Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details. properties: operationId: description: "If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the name of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`." type: string protoDescriptors: description: Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). format: byte type: string statements: description: Required. DDL statements to be applied to the database. items: type: string type: array type: object UpdateDatabaseMetadata: description: Metadata type for the operation returned by UpdateDatabase. properties: cancelTime: description: The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is best-effort). format: google-datetime type: string progress: $ref: "#/components/schemas/OperationProgress" description: The progress of the UpdateDatabase operation. request: $ref: "#/components/schemas/UpdateDatabaseRequest" description: The request for UpdateDatabase. type: object UpdateDatabaseRequest: description: The request for UpdateDatabase. properties: database: $ref: "#/components/schemas/Database" description: Required. The database to update. The `name` field of the database is of the form `projects//instances//databases/`. updateMask: description: Required. The list of fields to update. Currently, only `enable_drop_protection` field can be updated. format: google-fieldmask type: string type: object UpdateInstanceConfigMetadata: description: Metadata type for the operation returned by UpdateInstanceConfig. properties: cancelTime: description: The time at which this operation was cancelled. format: google-datetime type: string instanceConfig: $ref: "#/components/schemas/InstanceConfig" description: The desired instance config after updating. progress: $ref: "#/components/schemas/InstanceOperationProgress" description: The progress of the UpdateInstanceConfig operation. type: object UpdateInstanceConfigRequest: description: The request for UpdateInstanceConfigRequest. properties: instanceConfig: $ref: "#/components/schemas/InstanceConfig" description: Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. updateMask: description: Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated. format: google-fieldmask type: string validateOnly: description: An option to validate, but not actually execute, a request, and provide the same response. type: boolean type: object UpdateInstanceMetadata: description: Metadata type for the operation returned by UpdateInstance. properties: cancelTime: description: The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot 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 expectedFulfillmentPeriod: description: The expected fulfillment period of this update operation. enum: - FULFILLMENT_PERIOD_UNSPECIFIED - FULFILLMENT_PERIOD_NORMAL - FULFILLMENT_PERIOD_EXTENDED type: string instance: $ref: "#/components/schemas/Instance" description: The desired end state of the update. startTime: description: The time at which UpdateInstance request was received. format: google-datetime type: string type: object UpdateInstanceRequest: description: The request for UpdateInstance. properties: fieldMask: description: Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them. format: google-fieldmask type: string instance: $ref: "#/components/schemas/Instance" description: Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included. type: object VisualizationData: properties: dataSourceEndToken: description: The token signifying the end of a data_source. type: string dataSourceSeparatorToken: description: The token delimiting a datasource name from the rest of a key in a data_source. type: string diagnosticMessages: description: The list of messages (info, alerts, ...) items: $ref: "#/components/schemas/DiagnosticMessage" type: array endKeyStrings: description: We discretize the entire keyspace into buckets. Assuming each bucket has an inclusive keyrange and covers keys from k(i) ... k(n). In this case k(n) would be an end key for a given range. end_key_string is the collection of all such end keys items: type: string type: array hasPii: description: Whether this scan contains PII. type: boolean indexedKeys: description: Keys of key ranges that contribute significantly to a given metric Can be thought of as heavy hitters. items: type: string type: array keySeparator: description: The token delimiting the key prefixes. type: string keyUnit: description: "The unit for the key: e.g. 'key' or 'chunk'." enum: - KEY_UNIT_UNSPECIFIED - KEY - CHUNK type: string metrics: description: The list of data objects for each metric. items: $ref: "#/components/schemas/Metric" type: array prefixNodes: description: The list of extracted key prefix nodes used in the key prefix hierarchy. items: $ref: "#/components/schemas/PrefixNode" type: array type: object Write: description: Arguments to insert, update, insert_or_update, and replace operations. properties: columns: description: The names of the columns in table to be written. The list of columns must contain enough columns to allow Cloud Spanner to derive values for all primary key columns in the row(s) to be modified. items: type: string type: array table: description: Required. The table whose rows will be written. type: string values: description: The values to be written. `values` can contain more than one list of values. If it does, then multiple rows are written, one for each entry in `values`. Each list in `values` must have exactly as many entries as there are entries in columns above. Sending multiple lists is equivalent to sending multiple `Mutation`s, each containing one `values` entry and repeating table and columns. Individual values in each list are encoded as described here. items: items: {} type: array type: array type: object securitySchemes: Oauth2: description: Oauth 2.0 implicit authentication flows: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/spanner.admin: Administer your Spanner databases https://www.googleapis.com/auth/spanner.data: View and manage the contents of your Spanner databases type: oauth2 Oauth2c: description: Oauth 2.0 authorizationCode authentication flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/spanner.admin: Administer your Spanner databases https://www.googleapis.com/auth/spanner.data: View and manage the contents of your Spanner databases tokenUrl: https://accounts.google.com/o/oauth2/token type: oauth2