Namespace Google.Apis.Spanner.v1

Classes

ProjectsResource

The "projects" collection of methods.

ProjectsResource.InstanceConfigsResource

The "instanceConfigs" collection of methods.

ProjectsResource.InstanceConfigsResource.GetRequest

Gets information about a particular instance configuration.

ProjectsResource.InstanceConfigsResource.ListRequest

Lists the supported instance configurations for a given project.

ProjectsResource.InstanceConfigsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.InstanceConfigsResource.OperationsResource.CancelRequest

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.

ProjectsResource.InstanceConfigsResource.OperationsResource.DeleteRequest

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.

ProjectsResource.InstanceConfigsResource.OperationsResource.GetRequest

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.

ProjectsResource.InstanceConfigsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

ProjectsResource.InstancesResource

The "instances" collection of methods.

ProjectsResource.InstancesResource.BackupOperationsResource

The "backupOperations" collection of methods.

ProjectsResource.InstancesResource.BackupOperationsResource.ListRequest

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.

ProjectsResource.InstancesResource.BackupsResource

The "backups" collection of methods.

ProjectsResource.InstancesResource.BackupsResource.CopyRequest

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 backup. Concurrent CopyBackup requests can run on the same source backup.

ProjectsResource.InstancesResource.BackupsResource.CreateRequest

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.

ProjectsResource.InstancesResource.BackupsResource.DeleteRequest

Deletes a pending or completed Backup.

ProjectsResource.InstancesResource.BackupsResource.GetIamPolicyRequest

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.

ProjectsResource.InstancesResource.BackupsResource.GetRequest

Gets metadata on a pending or completed Backup.

ProjectsResource.InstancesResource.BackupsResource.ListRequest

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

ProjectsResource.InstancesResource.BackupsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.InstancesResource.BackupsResource.OperationsResource.CancelRequest

ProjectsResource.InstancesResource.BackupsResource.OperationsResource.DeleteRequest

ProjectsResource.InstancesResource.BackupsResource.OperationsResource.GetRequest

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.

ProjectsResource.InstancesResource.BackupsResource.OperationsResource.ListRequest

ProjectsResource.InstancesResource.BackupsResource.PatchRequest

Updates a pending or completed Backup.

ProjectsResource.InstancesResource.BackupsResource.SetIamPolicyRequest

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.

ProjectsResource.InstancesResource.BackupsResource.TestIamPermissionsRequest

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.

ProjectsResource.InstancesResource.CreateRequest

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.

ProjectsResource.InstancesResource.DatabaseOperationsResource

The "databaseOperations" collection of methods.

ProjectsResource.InstancesResource.DatabaseOperationsResource.ListRequest

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.

ProjectsResource.InstancesResource.DatabasesResource

The "databases" collection of methods.

ProjectsResource.InstancesResource.DatabasesResource.CreateRequest

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format /operations/ and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

ProjectsResource.InstancesResource.DatabasesResource.DatabaseRolesResource

The "databaseRoles" collection of methods.

ProjectsResource.InstancesResource.DatabasesResource.DatabaseRolesResource.ListRequest

Lists Cloud Spanner database roles.

ProjectsResource.InstancesResource.DatabasesResource.DatabaseRolesResource.TestIamPermissionsRequest

ProjectsResource.InstancesResource.DatabasesResource.DropDatabaseRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.GetDdlRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.GetIamPolicyRequest

ProjectsResource.InstancesResource.DatabasesResource.GetRequest

Gets the state of a Cloud Spanner database.

ProjectsResource.InstancesResource.DatabasesResource.GetScansRequest

Request a specific scan with Database-specific data for Cloud Key Visualizer.

ProjectsResource.InstancesResource.DatabasesResource.ListRequest

Lists Cloud Spanner databases.

ProjectsResource.InstancesResource.DatabasesResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.InstancesResource.DatabasesResource.OperationsResource.CancelRequest

ProjectsResource.InstancesResource.DatabasesResource.OperationsResource.DeleteRequest

ProjectsResource.InstancesResource.DatabasesResource.OperationsResource.GetRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.OperationsResource.ListRequest

ProjectsResource.InstancesResource.DatabasesResource.RestoreRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource

The "sessions" collection of methods.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.BatchCreateRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.BeginTransactionRequest

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.CommitRequest

Commits a transaction. The request includes the mutations to be applied to rows in the database. Commit might return an ABORTED error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If Commit returns ABORTED, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, Commit might return UNKNOWN. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.CreateRequest

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.DeleteRequest

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ExecuteBatchDmlRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ExecuteSqlRequest

Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a FAILED_PRECONDITION error. Operations inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ExecuteStreamingSqlRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.GetRequest

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ListRequest

Lists all sessions in a given database.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.PartitionQueryRequest

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.PartitionReadRequest

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ReadRequest

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a FAILED_PRECONDITION error. Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.RollbackRequest

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.StreamingReadRequest

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.

ProjectsResource.InstancesResource.DatabasesResource.SetIamPolicyRequest

ProjectsResource.InstancesResource.DatabasesResource.TestIamPermissionsRequest

ProjectsResource.InstancesResource.DatabasesResource.UpdateDdlRequest

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format /operations/ and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.

ProjectsResource.InstancesResource.DeleteRequest

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.

ProjectsResource.InstancesResource.GetIamPolicyRequest

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.

ProjectsResource.InstancesResource.GetRequest

Gets information about a particular instance.

ProjectsResource.InstancesResource.ListRequest

Lists all instances in the given project.

ProjectsResource.InstancesResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.InstancesResource.OperationsResource.CancelRequest

ProjectsResource.InstancesResource.OperationsResource.DeleteRequest

ProjectsResource.InstancesResource.OperationsResource.GetRequest

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.

ProjectsResource.InstancesResource.OperationsResource.ListRequest

ProjectsResource.InstancesResource.PatchRequest

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.

ProjectsResource.InstancesResource.SetIamPolicyRequest

Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires spanner.instances.setIamPolicy on resource.

ProjectsResource.InstancesResource.TestIamPermissionsRequest

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.

ScansResource

The "scans" collection of methods.

ScansResource.ListRequest

Return available scans given a Database-specific resource name.

SpannerBaseServiceRequest<TResponse>

A base abstract class for Spanner requests.

SpannerService

The Spanner Service.

SpannerService.Scope

Available OAuth 2.0 scopes for use with the Cloud Spanner API.

SpannerService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Cloud Spanner API.

Namespace Google.Apis.Spanner.v1

Classes

Enums