2026-02-27
▼ ▲ spanner.scans.list
Path : v1/{+parent}
Flat Path : v1/scans
Scopes :
Parameters :
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous List request, if any.
view
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.
Enum Descriptions :
Type : string
Location : query
Enum :
parent
Type : string
Description : Required. The unique name of the parent resource, specific to the Database service implementing this interface.
Pattern : ^scans$
Required : Yes
Location : path
pageSize
Description : The maximum number of items to return.
Format : int32
Type : integer
Location : query
filter
Location : query
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`.
Parameter Order : parent
Description : Return available scans given a Database-specific resource name.
HTTP Method : GET
▼ ▲ spanner.projects.instances.databaseOperations.list
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databaseOperations
Parameters :
pageToken
Location : query
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`.
Type : string
parent
Type : string
Description : Required. The instance of the database operations. Values are of the form `projects//instances/`.
Pattern : ^projects/[^/]+/instances/[^/]+$
Required : Yes
Location : path
pageSize
Format : int32
Description : Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Location : query
Type : integer
filter
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.
Location : query
Type : string
Path : v1/{+parent}/databaseOperations
Scopes :
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.
HTTP Method : GET
▼ ▲ spanner.projects.instances.databases.backupSchedules.testIamPermissions
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. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database.
Parameter Order : resource
Scopes :
Parameters :
resource
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location : path
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.
Type : string
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions
Path : v1/{+resource}:testIamPermissions
▼ ▲ spanner.projects.instances.databases.backupSchedules.patch
Description : Updates a backup schedule.
Scopes :
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Description : Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally.
▼ ▲ spanner.projects.instances.databases.backupSchedules.get
Scopes :
Description : Gets backup schedule for the input schedule name.
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Description : Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`.
Type : string
Required : Yes
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
▼ ▲ spanner.projects.instances.databases.backupSchedules.getIamPolicy
Parameter Order : resource
Parameters :
resource
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.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Required : Yes
Location : path
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. For backup schedules, authorization requires `spanner.backupSchedules.getIamPolicy` permission on resource.
Scopes :
Path : v1/{+resource}:getIamPolicy
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy
▼ ▲ spanner.projects.instances.databases.backupSchedules.delete
Scopes :
Parameter Order : name
Description : Deletes a backup schedule.
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location : path
Description : Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`.
Required : Yes
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
HTTP Method : DELETE
Path : v1/{+name}
▼ ▲ spanner.projects.instances.databases.backupSchedules.create
Scopes :
Parameters :
parent
Description : Required. The name of the database that this backup schedule applies to.
Type : string
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Required : Yes
backupScheduleId
Description : Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`.
Location : query
Type : string
Parameter Order : parent
Path : v1/{+parent}/backupSchedules
Description : Creates a new backup schedule.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules
HTTP Method : POST
▼ ▲ spanner.projects.instances.databases.backupSchedules.setIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
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.
Location : path
Required : Yes
Type : string
HTTP Method : 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. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource.
Scopes :
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy
▼ ▲ spanner.projects.instances.databases.backupSchedules.list
Path : v1/{+parent}/backupSchedules
Description : Lists all the backup schedules for the database.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules
HTTP Method : GET
Parameters :
pageSize
Description : Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Format : int32
Location : query
Type : integer
parent
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Location : path
Type : string
Description : Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/
Required : Yes
pageToken
Type : string
Description : Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.
Location : query
Parameter Order : parent
Scopes :
▼ ▲ spanner.projects.instances.databases.sessions.executeStreamingSql
Path : v1/{+session}:executeStreamingSql
Scopes :
Parameters :
session
Required : Yes
Location : path
Type : string
Description : Required. The session in which the SQL query should be performed.
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql
Parameter Order : session
HTTP Method : 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. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
▼ ▲ spanner.projects.instances.databases.sessions.list
HTTP Method : GET
Description : Lists all sessions in a given database.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions
Parameter Order : database
Scopes :
Path : v1/{+database}/sessions
Parameters :
pageSize
Description : Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Format : int32
Type : integer
Location : query
database
Required : Yes
Location : path
Description : Required. The database in which to list sessions.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
filter
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".
Location : query
Type : string
pageToken
Location : query
Description : If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse.
Type : string
▼ ▲ spanner.projects.instances.databases.sessions.commit
Parameter Order : session
HTTP Method : POST
Path : v1/{+session}:commit
Parameters :
session
Location : path
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Description : Required. The session in which the transaction to be committed is running.
Type : string
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit
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 retry the transaction from the beginning, reusing 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.
▼ ▲ spanner.projects.instances.databases.sessions.create
Path : v1/{+database}/sessions
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's a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions when 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, for example, `"SELECT 1"`.
Parameter Order : database
HTTP Method : POST
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions
Parameters :
database
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Type : string
Description : Required. The database in which the new session is created.
Location : path
Required : Yes
▼ ▲ spanner.projects.instances.databases.sessions.executeBatchDml
Parameters :
session
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Description : Required. The session in which the DML statements should be performed.
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.
Path : v1/{+session}:executeBatchDml
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeBatchDml
HTTP Method : POST
Scopes :
Parameter Order : session
▼ ▲ spanner.projects.instances.databases.sessions.adaptMessage
Scopes :
Parameter Order : name
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:adaptMessage
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Description : Required. The database session in which the adapter request is processed.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Path : v1/{+name}:adaptMessage
Description : Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the client.
▼ ▲ spanner.projects.instances.databases.sessions.executeSql
Description : Executes an SQL statement, returning all results in a single reply. This method can't 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. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
Parameters :
session
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Description : Required. The session in which the SQL query should be performed.
Location : path
Type : string
Required : Yes
Path : v1/{+session}:executeSql
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql
Parameter Order : session
Scopes :
HTTP Method : POST
▼ ▲ spanner.projects.instances.databases.sessions.partitionRead
Parameters :
session
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Description : Required. The session used to create the partitions.
Location : path
Type : string
Parameter Order : session
HTTP Method : POST
Scopes :
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 isn't possible to resume the read, and the whole operation must be restarted from the beginning.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionRead
Path : v1/{+session}:partitionRead
▼ ▲ spanner.projects.instances.databases.sessions.streamingRead
HTTP Method : POST
Parameters :
session
Description : Required. The session in which the read should be performed.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
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.
Path : v1/{+session}:streamingRead
Parameter Order : session
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead
Scopes :
▼ ▲ spanner.projects.instances.databases.sessions.adapter
Description : Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many `AdaptMessage` calls.
Scopes :
Path : v1/{+parent}/sessions:adapter
HTTP Method : POST
Parameters :
parent
Type : string
Location : path
Description : Required. The database in which the new session is created.
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Required : Yes
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:adapter
Parameter Order : parent
▼ ▲ spanner.projects.instances.databases.sessions.rollback
Description : Rolls back a transaction, releasing any locks it holds. It's 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 isn't found. `Rollback` never returns `ABORTED`.
Parameters :
session
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Description : Required. The session in which the transaction to roll back is running.
Type : string
Location : path
Required : Yes
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback
HTTP Method : POST
Path : v1/{+session}:rollback
Parameter Order : session
Scopes :
▼ ▲ spanner.projects.instances.databases.sessions.get
Description : Gets a session. Returns `NOT_FOUND` if the session doesn't exist. This is mainly useful for determining whether a session is still alive.
Path : v1/{+name}
Parameter Order : name
Scopes :
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the session to retrieve.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}
▼ ▲ spanner.projects.instances.databases.sessions.batchCreate
Parameters :
database
Required : Yes
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Location : path
Description : Required. The database in which the new sessions are created.
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.
Scopes :
Parameter Order : database
Path : v1/{+database}/sessions:batchCreate
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:batchCreate
▼ ▲ spanner.projects.instances.databases.sessions.read
Description : Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method can't 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.
Parameter Order : session
HTTP Method : POST
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read
Path : v1/{+session}:read
Parameters :
session
Type : string
Description : Required. The session in which the read should be performed.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
▼ ▲ spanner.projects.instances.databases.sessions.beginTransaction
Scopes :
Path : v1/{+session}:beginTransaction
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction
HTTP Method : 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.
Parameters :
session
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Description : Required. The session in which the transaction runs.
Parameter Order : session
▼ ▲ spanner.projects.instances.databases.sessions.batchWrite
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, that is, some groups might have been committed successfully, while some might 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 can be applied more than once. Replays of non-idempotent mutations can have undesirable effects. For example, replays of an insert mutation can produce an already exists error or if you use generated or commit timestamp-based keys, it can result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.
Path : v1/{+session}:batchWrite
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:batchWrite
Parameter Order : session
HTTP Method : POST
Scopes :
Parameters :
session
Location : path
Description : Required. The session in which the batch request is to be run.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
▼ ▲ spanner.projects.instances.databases.sessions.delete
Path : v1/{+name}
HTTP Method : DELETE
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}
Description : Ends a session, releasing server resources associated with it. This asynchronously triggers the cancellation of any operations that are running with this session.
Parameter Order : name
Parameters :
name
Required : Yes
Description : Required. The name of the session to delete.
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Type : string
▼ ▲ spanner.projects.instances.databases.sessions.partitionQuery
HTTP Method : 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 isn't possible to resume the query, and the whole operation must be restarted from the beginning.
Parameter Order : session
Parameters :
session
Required : Yes
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$
Description : Required. The session used to create the partitions.
Type : string
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionQuery
Path : v1/{+session}:partitionQuery
▼ ▲ spanner.projects.instances.databases.databaseRoles.testIamPermissions
Parameters :
resource
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.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/databaseRoles/[^/]+$
HTTP Method : POST
Path : v1/{+resource}:testIamPermissions
Scopes :
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles/{databaseRolesId}:testIamPermissions
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. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database.
▼ ▲ spanner.projects.instances.databases.databaseRoles.list
HTTP Method : GET
Scopes :
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles
Parameters :
pageToken
Location : query
Type : string
Description : If non-empty, `page_token` should contain a next_page_token from a previous ListDatabaseRolesResponse.
pageSize
Description : Number of database roles to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Type : integer
Format : int32
Location : query
parent
Description : Required. The database whose roles should be listed. Values are of the form `projects//instances//databases/`.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Location : path
Required : Yes
Description : Lists Cloud Spanner database roles.
Path : v1/{+parent}/databaseRoles
▼ ▲ spanner.projects.instances.databases.operations.list
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations
Parameter Order : name
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
Scopes :
Path : v1/{+name}
Parameters :
pageToken
Description : The standard list page token.
Location : query
Type : string
name
Required : Yes
Location : path
Description : The name of the operation's parent resource.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$
filter
Type : string
Description : The standard list filter.
Location : query
pageSize
Type : integer
Location : query
Description : The standard list page size.
Format : int32
returnPartialSuccess
Location : query
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
▼ ▲ spanner.projects.instances.databases.operations.get
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}
Parameter Order : name
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters :
name
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Type : string
Description : The name of the operation resource.
Scopes :
Path : v1/{+name}
HTTP Method : GET
▼ ▲ spanner.projects.instances.databases.operations.delete
Scopes :
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`.
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}
Parameters :
name
Location : path
Description : The name of the operation resource to be deleted.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$
Required : Yes
HTTP Method : DELETE
▼ ▲ spanner.projects.instances.databases.operations.cancel
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$
Location : path
HTTP Method : POST
Parameter Order : name
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel
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`.
Scopes :
▼ ▲ spanner.projects.instances.databases.create
Parameter Order : parent
Scopes :
Description : Creates a new 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.
Parameters :
parent
Pattern : ^projects/[^/]+/instances/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases
HTTP Method : POST
Path : v1/{+parent}/databases
▼ ▲ spanner.projects.instances.databases.setIamPolicy
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy
Parameters :
resource
Required : Yes
Location : path
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.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Scopes :
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. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource.
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
HTTP Method : POST
▼ ▲ spanner.projects.instances.databases.get
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the requested database. Values are of the form `projects//instances//databases/`.
Scopes :
HTTP Method : GET
Description : Gets the state of a Cloud Spanner database.
Path : v1/{+name}
Parameter Order : name
▼ ▲ spanner.projects.instances.databases.updateDdl
Parameter Order : database
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl
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 changes. The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.
HTTP Method : PATCH
Parameters :
database
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The database to update.
Scopes :
Path : v1/{+database}/ddl
▼ ▲ spanner.projects.instances.databases.dropDatabase
Parameters :
database
Description : Required. The database to be dropped.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}
HTTP Method : DELETE
Path : v1/{+database}
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.
Parameter Order : database
▼ ▲ spanner.projects.instances.databases.patch
Parameters :
name
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
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.
Location : path
Required : Yes
Type : string
updateMask
Location : query
Format : google-fieldmask
Description : Required. The list of fields to update. Currently, only `enable_drop_protection` field can be updated.
Type : string
Parameter Order : name
Path : v1/{+name}
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}
HTTP Method : 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.
▼ ▲ spanner.projects.instances.databases.getIamPolicy
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. For backup schedules, authorization requires `spanner.backupSchedules.getIamPolicy` permission on resource.
Path : v1/{+resource}:getIamPolicy
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy
Parameter Order : resource
Scopes :
Parameters :
resource
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
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.
▼ ▲ spanner.projects.instances.databases.list
Description : Lists Cloud Spanner databases.
Scopes :
Path : v1/{+parent}/databases
HTTP Method : GET
Parameter Order : parent
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+$
Type : string
Description : Required. The instance whose databases should be listed. Values are of the form `projects//instances/`.
Location : path
pageToken
Description : If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse.
Type : string
Location : query
pageSize
Type : integer
Location : query
Format : int32
Description : Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases
▼ ▲ spanner.projects.instances.databases.getScans
HTTP Method : GET
Scopes :
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Required : Yes
Description : Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface.
view
Type : string
Description : Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed.
Enum :
Enum Descriptions :
Location : query
startTime
Type : string
Location : query
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.
Format : google-datetime
endTime
Description : The upper bound for the time range to retrieve Scan data for.
Location : query
Format : google-datetime
Type : string
Parameter Order : name
Path : v1/{+name}/scans
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/scans
Description : Request a specific scan with Database-specific data for Cloud Key Visualizer.
▼ ▲ spanner.projects.instances.databases.changequorum
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:changequorum
HTTP Method : POST
Scopes :
Parameters :
name
Description : Required. Name of the database in which to apply `ChangeQuorum`. Values are of the form `projects//instances//databases/`.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Required : Yes
Location : path
Path : v1/{+name}:changequorum
Description : `ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.
Parameter Order : name
▼ ▲ spanner.projects.instances.databases.testIamPermissions
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. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database.
Parameter Order : resource
Parameters :
resource
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Required : Yes
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.
Location : path
Path : v1/{+resource}:testIamPermissions
Scopes :
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions
▼ ▲ spanner.projects.instances.databases.restore
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases:restore
Path : v1/{+parent}/databases:restore
HTTP Method : 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.
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+$
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/`.
Location : path
Scopes :
▼ ▲ spanner.projects.instances.databases.getDdl
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl
Parameters :
database
Required : Yes
Description : Required. The database whose schema we wish to get. Values are of the form `projects//instances//databases/`
Location : path
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
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.
Path : v1/{+database}/ddl
HTTP Method : GET
Scopes :
Parameter Order : database
▼ ▲ spanner.projects.instances.databases.addSplitPoints
Parameters :
database
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Required : Yes
Description : Required. The database on whose tables or indexes the split points are to be added. Values are of the form `projects//instances//databases/`.
Location : path
Parameter Order : database
Description : Adds split points to specified tables and indexes of a database.
Scopes :
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:addSplitPoints
Path : v1/{+database}:addSplitPoints
▼ ▲ spanner.projects.instances.instancePartitions.delete
Scopes :
Parameter Order : name
Description : Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires `spanner.instancePartitions.delete` permission on the resource name.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}
Parameters :
etag
Type : string
Location : query
Description : Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition.
name
Description : Required. The name of the instance partition to be deleted. Values are of the form `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+$
HTTP Method : DELETE
▼ ▲ spanner.projects.instances.instancePartitions.create
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions
Parameter Order : parent
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+$
Description : Required. The name of the instance in which to create the instance partition. Values are of the form `projects//instances/`.
Type : string
Required : Yes
Path : v1/{+parent}/instancePartitions
HTTP Method : POST
Description : Creates an instance partition and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance partition. The instance partition name is assigned by the caller. If the named instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance partition 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 partition immediately unreadable via the API. * The instance partition can be deleted. * All other attempts to modify the instance partition 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 start using this instance partition. * The instance partition's allocated resource levels are readable via the API. * The instance partition'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 partition. The metadata field type is CreateInstancePartitionMetadata. The response field type is InstancePartition, if successful.
Scopes :
▼ ▲ spanner.projects.instances.instancePartitions.get
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Description : Required. The name of the requested instance partition. Values are of the form `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+$
Location : path
Required : Yes
Description : Gets information about a particular instance partition.
Parameter Order : name
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}
▼ ▲ spanner.projects.instances.instancePartitions.patch
Description : Updates an instance partition, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance partition. If the named instance partition does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance partition's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance partition are rejected. * Reading the instance partition via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance partition's tables. * The instance partition's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance partition modification. The metadata field type is UpdateInstancePartitionMetadata. The response field type is InstancePartition, if successful. Authorization requires `spanner.instancePartitions.update` permission on the resource name.
Scopes :
HTTP Method : PATCH
Path : v1/{+name}
Parameters :
name
Type : string
Description : Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.
Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+$
Required : Yes
Location : path
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}
Parameter Order : name
▼ ▲ spanner.projects.instances.instancePartitions.list
Parameter Order : parent
Path : v1/{+parent}/instancePartitions
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions
Description : Lists all instance partitions for the given instance.
Parameters :
parent
Pattern : ^projects/[^/]+/instances/[^/]+$
Description : Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`. Use `{instance} = '-'` to list instance partitions for all Instances in a project, e.g., `projects/myproject/instances/-`.
Location : path
Type : string
Required : Yes
instancePartitionDeadline
Location : query
Format : google-datetime
Type : string
Description : Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.
pageToken
Description : If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse.
Type : string
Location : query
pageSize
Location : query
Format : int32
Description : Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Type : integer
HTTP Method : GET
▼ ▲ spanner.projects.instances.instancePartitions.operations.get
Path : v1/{+name}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters :
name
Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Description : The name of the operation resource.
Location : path
HTTP Method : GET
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}
Parameter Order : name
▼ ▲ spanner.projects.instances.instancePartitions.operations.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`.
HTTP Method : DELETE
Path : v1/{+name}
Scopes :
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Required : Yes
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}
Parameter Order : name
▼ ▲ spanner.projects.instances.instancePartitions.operations.cancel
Scopes :
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Parameter Order : name
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}:cancel
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`.
HTTP Method : POST
Path : v1/{+name}:cancel
▼ ▲ spanner.projects.instances.instancePartitions.operations.list
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations
Path : v1/{+name}
Parameter Order : name
Parameters :
pageSize
Format : int32
Description : The standard list page size.
Location : query
Type : integer
pageToken
Location : query
Type : string
Description : The standard list page token.
filter
Description : The standard list filter.
Location : query
Type : string
name
Required : Yes
Location : path
Type : string
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations$
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes :
▼ ▲ spanner.projects.instances.operations.get
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
HTTP Method : GET
Path : v1/{+name}
Scopes :
Parameter Order : name
▼ ▲ spanner.projects.instances.operations.list
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/operations
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes :
Path : v1/{+name}
Parameters :
pageSize
Format : int32
Location : query
Type : integer
Description : The standard list page size.
filter
Location : query
Description : The standard list filter.
Type : string
name
Location : path
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/operations$
Required : Yes
Description : The name of the operation's parent resource.
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
pageToken
Type : string
Location : query
Description : The standard list page token.
Parameter Order : name
▼ ▲ spanner.projects.instances.operations.cancel
Parameter Order : name
HTTP Method : POST
Scopes :
Parameters :
name
Description : The name of the operation resource to be cancelled.
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel
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`.
▼ ▲ spanner.projects.instances.operations.delete
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource to be deleted.
Required : Yes
HTTP Method : DELETE
Scopes :
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`.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}
▼ ▲ spanner.projects.instances.instancePartitionOperations.list
Parameters :
pageToken
Description : Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same `parent` and with the same `filter`.
Type : string
Location : query
filter
Location : query
Type : string
Description : Optional. 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 CreateInstancePartitionMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`. * `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.CreateInstancePartitionMetadata) AND` \ `(metadata.instance_partition.name:custom-instance-partition) AND` \ `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstancePartitionMetadata. * The instance partition name contains "custom-instance-partition". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
pageSize
Description : Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Location : query
Type : integer
Format : int32
instancePartitionDeadline
Description : Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
Location : query
Type : string
Format : google-datetime
parent
Pattern : ^projects/[^/]+/instances/[^/]+$
Type : string
Description : Required. The parent instance of the instance partition operations. Values are of the form `projects//instances/`.
Location : path
Required : Yes
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitionOperations
Description : Lists instance partition long-running operations in the given instance. An instance partition operation has a name of the form `projects//instances//instancePartitions//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. Authorization requires `spanner.instancePartitionOperations.list` permission on the resource parent.
Scopes :
Parameter Order : parent
HTTP Method : GET
Path : v1/{+parent}/instancePartitionOperations
▼ ▲ spanner.projects.instances.backupOperations.list
Parameters :
pageSize
Location : query
Description : Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Type : integer
Format : int32
pageToken
Type : string
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`.
Location : query
filter
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.
Type : string
Location : query
parent
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+$
Description : Required. The instance of the backup operations. Values are of the form `projects//instances/`.
Location : path
Type : string
Path : v1/{+parent}/backupOperations
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.
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backupOperations
Scopes :
HTTP Method : GET
▼ ▲ spanner.projects.instances.backups.operations.delete
Parameter Order : name
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}
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`.
Path : v1/{+name}
Parameters :
name
Type : string
Location : path
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+/operations/[^/]+$
HTTP Method : DELETE
▼ ▲ spanner.projects.instances.backups.operations.list
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations
Scopes :
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters :
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
name
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+/operations$
Description : The name of the operation's parent resource.
Location : path
Required : Yes
filter
Type : string
Description : The standard list filter.
Location : query
pageSize
Type : integer
Description : The standard list page size.
Location : query
Format : int32
pageToken
Location : query
Type : string
Description : The standard list page token.
Parameter Order : name
Path : v1/{+name}
▼ ▲ spanner.projects.instances.backups.operations.cancel
Parameter Order : name
Path : v1/{+name}:cancel
Scopes :
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}:cancel
Parameters :
name
Location : path
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+/operations/[^/]+$
Required : Yes
Type : string
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`.
▼ ▲ spanner.projects.instances.backups.operations.get
HTTP Method : GET
Parameter Order : name
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource.
Type : string
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}
Path : v1/{+name}
▼ ▲ spanner.projects.instances.backups.delete
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}
Parameter Order : name
Parameters :
name
Description : Required. Name of the backup to delete. Values are of the form `projects//instances//backups/`.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+$
Path : v1/{+name}
HTTP Method : DELETE
Description : Deletes a pending or completed Backup.
Scopes :
▼ ▲ spanner.projects.instances.backups.setIamPolicy
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:setIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
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.
Scopes :
HTTP Method : POST
Path : v1/{+resource}:setIamPolicy
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. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource.
▼ ▲ spanner.projects.instances.backups.testIamPermissions
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. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database.
Scopes :
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:testIamPermissions
Parameters :
resource
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.
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+$
Location : path
Type : string
Required : Yes
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
▼ ▲ spanner.projects.instances.backups.patch
Parameter Order : name
Description : Updates a pending or completed Backup.
Path : v1/{+name}
Parameters :
updateMask
Description : Required. A mask specifying which fields (for example, `expire_time`) in the backup resource should be updated. This mask is relative to the backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.
Type : string
Format : google-fieldmask
Location : query
name
Required : Yes
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/`.
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+$
Type : string
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}
Scopes :
HTTP Method : PATCH
▼ ▲ spanner.projects.instances.backups.get
Parameters :
name
Type : string
Required : Yes
Location : path
Description : Required. Name of the backup. Values are of the form `projects//instances//backups/`.
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+$
Path : v1/{+name}
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}
Scopes :
Parameter Order : name
Description : Gets metadata on a pending or completed Backup.
▼ ▲ spanner.projects.instances.backups.create
Parameters :
encryptionConfig.kmsKeyNames
Repeated : Yes
Type : string
Description : Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
Location : query
encryptionConfig.kmsKeyName
Description : Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
Type : string
Location : query
parent
Pattern : ^projects/[^/]+/instances/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects//instances/`.
encryptionConfig.encryptionType
Type : string
Enum :
Location : query
Description : Required. The encryption type of the backup.
Enum Descriptions :
backupId
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/`.
Location : query
HTTP Method : POST
Parameter Order : parent
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups
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.
Path : v1/{+parent}/backups
▼ ▲ spanner.projects.instances.backups.copy
HTTP Method : 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.
Path : v1/{+parent}/backups:copy
Parameter Order : parent
Parameters :
parent
Location : path
Type : string
Description : Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`.
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+$
Scopes :
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups:copy
▼ ▲ spanner.projects.instances.backups.list
Description : Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.
Scopes :
Path : v1/{+parent}/backups
HTTP Method : GET
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups
Parameters :
pageToken
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`.
Type : string
Location : query
filter
Type : string
Location : query
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` * `backup_schedules` 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 * `backup_schedules:daily` - The backup is created from a schedule with "daily" in its name.
parent
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+$
Description : Required. The instance to list backups from. Values are of the form `projects//instances/`.
Location : path
Required : Yes
pageSize
Description : Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Type : integer
Location : query
Format : int32
▼ ▲ spanner.projects.instances.backups.getIamPolicy
Parameters :
resource
Type : string
Required : Yes
Location : path
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.
Pattern : ^projects/[^/]+/instances/[^/]+/backups/[^/]+$
Flat Path : v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:getIamPolicy
Parameter Order : resource
HTTP Method : POST
Scopes :
Path : v1/{+resource}:getIamPolicy
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. For backup schedules, authorization requires `spanner.backupSchedules.getIamPolicy` permission on resource.
▼ ▲ spanner.projects.instances.getIamPolicy
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/instances/[^/]+$
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.
Required : Yes
Type : string
Flat Path : v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy
Parameter Order : resource
HTTP Method : POST
Description : Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Authorization requires `spanner.instances.getIamPolicy` on resource.
Scopes :
Path : v1/{+resource}:getIamPolicy
▼ ▲ spanner.projects.instances.patch
Description : Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on the resource name.
Scopes :
Parameters :
name
Location : path
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.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+$
HTTP Method : PATCH
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/instances/{instancesId}
Parameter Order : name
▼ ▲ spanner.projects.instances.get
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/instances/{instancesId}
Parameter Order : name
Scopes :
Description : Gets information about a particular instance.
Parameters :
name
Type : string
Location : path
Description : Required. The name of the requested instance. Values are of the form `projects//instances/`.
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+$
fieldMask
Location : query
Format : google-fieldmask
Description : If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.
Type : string
Path : v1/{+name}
▼ ▲ spanner.projects.instances.move
Description : Moves an instance to the target instance configuration. You can use the returned long-running operation to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Is undergoing a move to a different instance configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup` * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance might experience higher read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any downtime. The returned long-running operation has a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate because it involves moving any data previously moved to the target instance configuration back to the original instance configuration. You can use this operation to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. If not cancelled, upon completion of the returned operation: * The instance successfully moves to the target instance configuration. * You are billed for compute and storage in target instance configuration. Authorization requires the `spanner.instances.update` permission on the resource instance. For more details, see [Move an instance](https://cloud.google.com/spanner/docs/move-instance).
Parameters :
name
Location : path
Description : Required. The instance to move. Values are of the form `projects//instances/`.
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+$
Type : string
Flat Path : v1/projects/{projectsId}/instances/{instancesId}:move
Parameter Order : name
Scopes :
Path : v1/{+name}:move
HTTP Method : POST
▼ ▲ spanner.projects.instances.create
Parameters :
parent
Description : Required. The name of the project in which to create the instance. Values are of the form `projects/`.
Pattern : ^projects/[^/]+$
Type : string
Required : Yes
Location : path
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.
Path : v1/{+parent}/instances
Parameter Order : parent
HTTP Method : POST
Scopes :
Flat Path : v1/projects/{projectsId}/instances
▼ ▲ spanner.projects.instances.list
Parameters :
filter
Type : string
Location : query
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".
instanceDeadline
Location : query
Format : google-datetime
Description : Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
Type : string
parent
Description : Required. The name of the project for which a list of instances is requested. Values are of the form `projects/`.
Location : path
Required : Yes
Pattern : ^projects/[^/]+$
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken
Description : If non-empty, `page_token` should contain a next_page_token from a previous ListInstancesResponse.
Type : string
Location : query
Description : Lists all instances in the given project.
Scopes :
Path : v1/{+parent}/instances
Flat Path : v1/projects/{projectsId}/instances
Parameter Order : parent
HTTP Method : GET
▼ ▲ spanner.projects.instances.setIamPolicy
Path : v1/{+resource}:setIamPolicy
Scopes :
Parameters :
resource
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.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/instances/[^/]+$
Flat Path : v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy
Description : Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires `spanner.instances.setIamPolicy` on resource.
HTTP Method : POST
Parameter Order : resource
▼ ▲ spanner.projects.instances.testIamPermissions
Path : v1/{+resource}:testIamPermissions
Parameters :
resource
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/instances/[^/]+$
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.
HTTP Method : POST
Description : Returns permissions that the caller has on the specified instance resource. Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.
Flat Path : v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions
Parameter Order : resource
Scopes :
▼ ▲ spanner.projects.instances.delete
HTTP Method : DELETE
Parameter Order : name
Scopes :
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/instances/{instancesId}
Parameters :
name
Location : path
Type : string
Required : Yes
Description : Required. The name of the instance to be deleted. Values are of the form `projects//instances/`
Pattern : ^projects/[^/]+/instances/[^/]+$
Description : Deletes an instance. Immediately upon completion of the request: * Billing ceases for all of the instance's reserved resources. Soon afterward: * The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
▼ ▲ spanner.projects.instanceConfigs.operations.list
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes :
Parameter Order : name
Path : v1/{+name}
Parameters :
returnPartialSuccess
Type : boolean
Location : query
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
name
Location : path
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/operations$
Type : string
Required : Yes
Description : The name of the operation's parent resource.
filter
Type : string
Description : The standard list filter.
Location : query
pageToken
Description : The standard list page token.
Type : string
Location : query
pageSize
Type : integer
Location : query
Description : The standard list page size.
Format : int32
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations
▼ ▲ spanner.projects.instanceConfigs.operations.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`.
Parameter Order : name
HTTP Method : DELETE
Path : v1/{+name}
Parameters :
name
Type : string
Required : Yes
Description : The name of the operation resource to be deleted.
Location : path
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/operations/[^/]+$
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}
Scopes :
▼ ▲ spanner.projects.instanceConfigs.operations.cancel
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}:cancel
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Location : path
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`.
HTTP Method : POST
Path : v1/{+name}:cancel
Scopes :
Parameter Order : name
▼ ▲ spanner.projects.instanceConfigs.operations.get
Scopes :
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource.
Location : path
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
▼ ▲ spanner.projects.instanceConfigs.ssdCaches.operations.cancel
Scopes :
HTTP Method : POST
Path : v1/{+name}:cancel
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/ssdCaches/[^/]+/operations/[^/]+$
Parameter Order : name
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/ssdCaches/{ssdCachesId}/operations/{operationsId}:cancel
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`.
▼ ▲ spanner.projects.instanceConfigs.ssdCaches.operations.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`.
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/ssdCaches/{ssdCachesId}/operations/{operationsId}
Path : v1/{+name}
Scopes :
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/ssdCaches/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Type : string
Required : Yes
HTTP Method : DELETE
Parameter Order : name
▼ ▲ spanner.projects.instanceConfigs.ssdCaches.operations.get
Scopes :
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/ssdCaches/[^/]+/operations/[^/]+$
Location : path
Type : string
Required : Yes
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/ssdCaches/{ssdCachesId}/operations/{operationsId}
Parameter Order : name
Path : v1/{+name}
▼ ▲ spanner.projects.instanceConfigs.ssdCaches.operations.list
Parameter Order : name
Parameters :
filter
Type : string
Description : The standard list filter.
Location : query
pageToken
Location : query
Description : The standard list page token.
Type : string
returnPartialSuccess
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
pageSize
Format : int32
Description : The standard list page size.
Type : integer
Location : query
name
Description : The name of the operation's parent resource.
Type : string
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+/ssdCaches/[^/]+/operations$
Location : path
Required : Yes
Path : v1/{+name}
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/ssdCaches/{ssdCachesId}/operations
HTTP Method : GET
Scopes :
▼ ▲ spanner.projects.instanceConfigs.list
Scopes :
Path : v1/{+parent}/instanceConfigs
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/instanceConfigs
Parameter Order : parent
Description : Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.
Parameters :
pageToken
Location : query
Type : string
Description : If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse.
parent
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+$
Description : Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`.
pageSize
Format : int32
Description : Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Location : query
Type : integer
▼ ▲ spanner.projects.instanceConfigs.patch
HTTP Method : PATCH
Description : Updates an instance configuration. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance configuration's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The new values of the instance configuration are readable via the API. * The instance configuration's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
Parameters :
name
Location : path
Type : string
Description : A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+$
Required : Yes
Parameter Order : name
Scopes :
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}
▼ ▲ spanner.projects.instanceConfigs.get
Description : Gets information about a particular instance configuration.
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}
Scopes :
Parameters :
name
Description : Required. The name of the requested instance configuration. Values are of the form `projects//instanceConfigs/`.
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+$
Required : Yes
Type : string
Location : path
▼ ▲ spanner.projects.instanceConfigs.delete
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}
Parameters :
validateOnly
Type : boolean
Description : An option to validate, but not actually execute, a request, and provide the same response.
Location : query
etag
Location : query
Type : string
Description : Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance configuration. Otherwise, deletes the instance configuration without checking the current status of the requested instance configuration.
name
Description : Required. The name of the instance configuration to be deleted. Values are of the form `projects//instanceConfigs/`
Required : Yes
Pattern : ^projects/[^/]+/instanceConfigs/[^/]+$
Location : path
Type : string
Scopes :
Description : Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.
Path : v1/{+name}
▼ ▲ spanner.projects.instanceConfigs.create
Path : v1/{+parent}/instanceConfigs
Flat Path : v1/projects/{projectsId}/instanceConfigs
Scopes :
HTTP Method : POST
Parameters :
parent
Required : Yes
Type : string
Description : Required. The name of the project in which to create the instance configuration. Values are of the form `projects/`.
Pattern : ^projects/[^/]+$
Location : path
Parameter Order : parent
Description : Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance configuration'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 configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
▼ ▲ spanner.projects.instanceConfigOperations.list
Description : Lists the user-managed instance configuration long-running operations in the given project. An instance configuration 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.
Parameters :
parent
Pattern : ^projects/[^/]+$
Description : Required. The project of the instance configuration operations. Values are of the form `projects/`.
Type : string
Location : path
Required : Yes
pageToken
Type : string
Location : query
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`.
pageSize
Format : int32
Location : query
Type : integer
Description : Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
filter
Location : query
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 configuration name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/instanceConfigOperations
Scopes :
Path : v1/{+parent}/instanceConfigOperations
HTTP Method : GET