Spanner

import { Spanner } from "https://googleapis.deno.dev/v1/spanner:v1.ts";

Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.

class Spanner {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsInstanceConfigOperationsList(parent: string, opts?: ProjectsInstanceConfigOperationsListOptions): Promise<ListInstanceConfigOperationsResponse>;

async projectsInstanceConfigsCreate(parent: string, req: CreateInstanceConfigRequest): Promise<Operation>;

async projectsInstanceConfigsDelete(name: string, opts?: ProjectsInstanceConfigsDeleteOptions): Promise<Empty>;

async projectsInstanceConfigsGet(name: string): Promise<InstanceConfig>;

async projectsInstanceConfigsList(parent: string, opts?: ProjectsInstanceConfigsListOptions): Promise<ListInstanceConfigsResponse>;

async projectsInstanceConfigsOperationsCancel(name: string): Promise<Empty>;

async projectsInstanceConfigsOperationsDelete(name: string): Promise<Empty>;

async projectsInstanceConfigsOperationsGet(name: string): Promise<Operation>;

async projectsInstanceConfigsOperationsList(name: string, opts?: ProjectsInstanceConfigsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsInstanceConfigsPatch(name: string, req: UpdateInstanceConfigRequest): Promise<Operation>;

async projectsInstanceConfigsSsdCachesOperationsCancel(name: string): Promise<Empty>;

async projectsInstanceConfigsSsdCachesOperationsDelete(name: string): Promise<Empty>;

async projectsInstanceConfigsSsdCachesOperationsGet(name: string): Promise<Operation>;

async projectsInstanceConfigsSsdCachesOperationsList(name: string, opts?: ProjectsInstanceConfigsSsdCachesOperationsListOptions): Promise<ListOperationsResponse>;

async projectsInstancesBackupOperationsList(parent: string, opts?: ProjectsInstancesBackupOperationsListOptions): Promise<ListBackupOperationsResponse>;

async projectsInstancesBackupsCopy(parent: string, req: CopyBackupRequest): Promise<Operation>;

async projectsInstancesBackupsCreate(

parent: string,

req: Backup,

opts?: ProjectsInstancesBackupsCreateOptions,

): Promise<Operation>;

async projectsInstancesBackupsDelete(name: string): Promise<Empty>;

async projectsInstancesBackupsGet(name: string): Promise<Backup>;

async projectsInstancesBackupsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsInstancesBackupsList(parent: string, opts?: ProjectsInstancesBackupsListOptions): Promise<ListBackupsResponse>;

async projectsInstancesBackupsOperationsCancel(name: string): Promise<Empty>;

async projectsInstancesBackupsOperationsDelete(name: string): Promise<Empty>;

async projectsInstancesBackupsOperationsGet(name: string): Promise<Operation>;

async projectsInstancesBackupsOperationsList(name: string, opts?: ProjectsInstancesBackupsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsInstancesBackupsPatch(

req: Backup,

opts?: ProjectsInstancesBackupsPatchOptions,

): Promise<Backup>;

async projectsInstancesBackupsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsInstancesBackupsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsInstancesCreate(parent: string, req: CreateInstanceRequest): Promise<Operation>;

async projectsInstancesDatabaseOperationsList(parent: string, opts?: ProjectsInstancesDatabaseOperationsListOptions): Promise<ListDatabaseOperationsResponse>;

async projectsInstancesDatabasesAddSplitPoints(database: string, req: AddSplitPointsRequest): Promise<AddSplitPointsResponse>;

async projectsInstancesDatabasesBackupSchedulesCreate(

parent: string,

req: BackupSchedule,

opts?: ProjectsInstancesDatabasesBackupSchedulesCreateOptions,

): Promise<BackupSchedule>;

async projectsInstancesDatabasesBackupSchedulesDelete(name: string): Promise<Empty>;

async projectsInstancesDatabasesBackupSchedulesGet(name: string): Promise<BackupSchedule>;

async projectsInstancesDatabasesBackupSchedulesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsInstancesDatabasesBackupSchedulesList(parent: string, opts?: ProjectsInstancesDatabasesBackupSchedulesListOptions): Promise<ListBackupSchedulesResponse>;

async projectsInstancesDatabasesBackupSchedulesPatch(

req: BackupSchedule,

opts?: ProjectsInstancesDatabasesBackupSchedulesPatchOptions,

): Promise<BackupSchedule>;

async projectsInstancesDatabasesBackupSchedulesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsInstancesDatabasesBackupSchedulesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsInstancesDatabasesChangequorum(name: string, req: ChangeQuorumRequest): Promise<Operation>;

async projectsInstancesDatabasesCreate(parent: string, req: CreateDatabaseRequest): Promise<Operation>;

async projectsInstancesDatabasesDatabaseRolesList(parent: string, opts?: ProjectsInstancesDatabasesDatabaseRolesListOptions): Promise<ListDatabaseRolesResponse>;

async projectsInstancesDatabasesDatabaseRolesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsInstancesDatabasesDropDatabase(database: string): Promise<Empty>;

async projectsInstancesDatabasesGet(name: string): Promise<Database>;

async projectsInstancesDatabasesGetDdl(database: string): Promise<GetDatabaseDdlResponse>;

async projectsInstancesDatabasesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsInstancesDatabasesGetScans(name: string, opts?: ProjectsInstancesDatabasesGetScansOptions): Promise<Scan>;

async projectsInstancesDatabasesList(parent: string, opts?: ProjectsInstancesDatabasesListOptions): Promise<ListDatabasesResponse>;

async projectsInstancesDatabasesOperationsCancel(name: string): Promise<Empty>;

async projectsInstancesDatabasesOperationsDelete(name: string): Promise<Empty>;

async projectsInstancesDatabasesOperationsGet(name: string): Promise<Operation>;

async projectsInstancesDatabasesOperationsList(name: string, opts?: ProjectsInstancesDatabasesOperationsListOptions): Promise<ListOperationsResponse>;

async projectsInstancesDatabasesPatch(

req: Database,

opts?: ProjectsInstancesDatabasesPatchOptions,

): Promise<Operation>;

async projectsInstancesDatabasesRestore(parent: string, req: RestoreDatabaseRequest): Promise<Operation>;

async projectsInstancesDatabasesSessionsAdapter(parent: string, req: AdapterSession): Promise<AdapterSession>;

async projectsInstancesDatabasesSessionsAdaptMessage(name: string, req: AdaptMessageRequest): Promise<AdaptMessageResponse>;

async projectsInstancesDatabasesSessionsBatchCreate(database: string, req: BatchCreateSessionsRequest): Promise<BatchCreateSessionsResponse>;

async projectsInstancesDatabasesSessionsBatchWrite(session: string, req: BatchWriteRequest): Promise<BatchWriteResponse>;

async projectsInstancesDatabasesSessionsBeginTransaction(session: string, req: BeginTransactionRequest): Promise<Transaction>;

async projectsInstancesDatabasesSessionsCommit(session: string, req: CommitRequest): Promise<CommitResponse>;

async projectsInstancesDatabasesSessionsCreate(database: string, req: CreateSessionRequest): Promise<Session>;

async projectsInstancesDatabasesSessionsDelete(name: string): Promise<Empty>;

async projectsInstancesDatabasesSessionsExecuteBatchDml(session: string, req: ExecuteBatchDmlRequest): Promise<ExecuteBatchDmlResponse>;

async projectsInstancesDatabasesSessionsExecuteSql(session: string, req: ExecuteSqlRequest): Promise<ResultSet>;

async projectsInstancesDatabasesSessionsExecuteStreamingSql(session: string, req: ExecuteSqlRequest): Promise<PartialResultSet>;

async projectsInstancesDatabasesSessionsGet(name: string): Promise<Session>;

async projectsInstancesDatabasesSessionsList(database: string, opts?: ProjectsInstancesDatabasesSessionsListOptions): Promise<ListSessionsResponse>;

async projectsInstancesDatabasesSessionsPartitionQuery(session: string, req: PartitionQueryRequest): Promise<PartitionResponse>;

async projectsInstancesDatabasesSessionsPartitionRead(session: string, req: PartitionReadRequest): Promise<PartitionResponse>;

async projectsInstancesDatabasesSessionsRead(session: string, req: ReadRequest): Promise<ResultSet>;

async projectsInstancesDatabasesSessionsRollback(session: string, req: RollbackRequest): Promise<Empty>;

async projectsInstancesDatabasesSessionsStreamingRead(session: string, req: ReadRequest): Promise<PartialResultSet>;

async projectsInstancesDatabasesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsInstancesDatabasesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsInstancesDatabasesUpdateDdl(database: string, req: UpdateDatabaseDdlRequest): Promise<Operation>;

async projectsInstancesDelete(name: string): Promise<Empty>;

async projectsInstancesGet(name: string, opts?: ProjectsInstancesGetOptions): Promise<Instance>;

async projectsInstancesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsInstancesInstancePartitionOperationsList(parent: string, opts?: ProjectsInstancesInstancePartitionOperationsListOptions): Promise<ListInstancePartitionOperationsResponse>;

async projectsInstancesInstancePartitionsCreate(parent: string, req: CreateInstancePartitionRequest): Promise<Operation>;

async projectsInstancesInstancePartitionsDelete(name: string, opts?: ProjectsInstancesInstancePartitionsDeleteOptions): Promise<Empty>;

async projectsInstancesInstancePartitionsGet(name: string): Promise<InstancePartition>;

async projectsInstancesInstancePartitionsList(parent: string, opts?: ProjectsInstancesInstancePartitionsListOptions): Promise<ListInstancePartitionsResponse>;

async projectsInstancesInstancePartitionsOperationsCancel(name: string): Promise<Empty>;

async projectsInstancesInstancePartitionsOperationsDelete(name: string): Promise<Empty>;

async projectsInstancesInstancePartitionsOperationsGet(name: string): Promise<Operation>;

async projectsInstancesInstancePartitionsOperationsList(name: string, opts?: ProjectsInstancesInstancePartitionsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsInstancesInstancePartitionsPatch(name: string, req: UpdateInstancePartitionRequest): Promise<Operation>;

async projectsInstancesList(parent: string, opts?: ProjectsInstancesListOptions): Promise<ListInstancesResponse>;

async projectsInstancesMove(name: string, req: MoveInstanceRequest): Promise<Operation>;

async projectsInstancesOperationsCancel(name: string): Promise<Empty>;

async projectsInstancesOperationsDelete(name: string): Promise<Empty>;

async projectsInstancesOperationsGet(name: string): Promise<Operation>;

async projectsInstancesOperationsList(name: string, opts?: ProjectsInstancesOperationsListOptions): Promise<ListOperationsResponse>;

async projectsInstancesPatch(name: string, req: UpdateInstanceRequest): Promise<Operation>;

async projectsInstancesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsInstancesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async scansList(parent: string, opts?: ScansListOptions): Promise<ListScansResponse>;

}

§Constructors

new Spanner(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsInstanceConfigOperationsList(parent: string, opts?: ProjectsInstanceConfigOperationsListOptions): Promise<ListInstanceConfigOperationsResponse>

[src]

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.

@param parent

Required. The project of the instance configuration operations. Values are of the form projects/.

projectsInstanceConfigsCreate(parent: string, req: CreateInstanceConfigRequest): Promise<Operation>

[src]

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.

@param parent

Required. The name of the project in which to create the instance configuration. Values are of the form projects/.

projectsInstanceConfigsDelete(name: string, opts?: ProjectsInstanceConfigsDeleteOptions): Promise<Empty>

[src]

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.

@param name

Required. The name of the instance configuration to be deleted. Values are of the form projects//instanceConfigs/

projectsInstanceConfigsGet(name: string): Promise<InstanceConfig>

[src]

Gets information about a particular instance configuration.

@param name

Required. The name of the requested instance configuration. Values are of the form projects//instanceConfigs/.

projectsInstanceConfigsList(parent: string, opts?: ProjectsInstanceConfigsListOptions): Promise<ListInstanceConfigsResponse>

[src]

Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.

@param parent

Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form projects/.

projectsInstanceConfigsOperationsCancel(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be cancelled.

projectsInstanceConfigsOperationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be deleted.

projectsInstanceConfigsOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsInstanceConfigsOperationsList(name: string, opts?: ProjectsInstanceConfigsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsInstanceConfigsPatch(name: string, req: UpdateInstanceConfigRequest): Promise<Operation>

[src]

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.

@param name

A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*. User instance configuration must start with custom-.

projectsInstanceConfigsSsdCachesOperationsCancel(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsInstanceConfigsSsdCachesOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsInstanceConfigsSsdCachesOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsInstanceConfigsSsdCachesOperationsList(name: string, opts?: ProjectsInstanceConfigsSsdCachesOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsInstancesBackupOperationsList(parent: string, opts?: ProjectsInstancesBackupOperationsListOptions): Promise<ListBackupOperationsResponse>

[src]

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.

@param parent

Required. The instance of the backup operations. Values are of the form projects//instances/.

projectsInstancesBackupsCopy(parent: string, req: CopyBackupRequest): Promise<Operation>

[src]

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.

@param parent

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects//instances/.

projectsInstancesBackupsCreate(parent: string, req: Backup, opts?: ProjectsInstancesBackupsCreateOptions): Promise<Operation>

[src]

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.

@param parent

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects//instances/.

projectsInstancesBackupsDelete(name: string): Promise<Empty>

[src]

Deletes a pending or completed Backup.

@param name

Required. Name of the backup to delete. Values are of the form projects//instances//backups/.

projectsInstancesBackupsGet(name: string): Promise<Backup>

[src]

Gets metadata on a pending or completed Backup.

@param name

Required. Name of the backup. Values are of the form projects//instances//backups/.

projectsInstancesBackupsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

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.

@param resource

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.

projectsInstancesBackupsList(parent: string, opts?: ProjectsInstancesBackupsListOptions): Promise<ListBackupsResponse>

[src]

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

@param parent

Required. The instance to list backups from. Values are of the form projects//instances/.

projectsInstancesBackupsOperationsCancel(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsInstancesBackupsOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsInstancesBackupsOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsInstancesBackupsOperationsList(name: string, opts?: ProjectsInstancesBackupsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsInstancesBackupsPatch(name: string, req: Backup, opts?: ProjectsInstancesBackupsPatchOptions): Promise<Backup>

[src]

Updates a pending or completed Backup.

@param name

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/.

projectsInstancesBackupsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

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.

@param resource

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.

projectsInstancesBackupsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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.

@param resource

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.

projectsInstancesCreate(parent: string, req: CreateInstanceRequest): Promise<Operation>

[src]

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.

@param parent

Required. The name of the project in which to create the instance. Values are of the form projects/.

projectsInstancesDatabaseOperationsList(parent: string, opts?: ProjectsInstancesDatabaseOperationsListOptions): Promise<ListDatabaseOperationsResponse>

[src]

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.

@param parent

Required. The instance of the database operations. Values are of the form projects//instances/.

projectsInstancesDatabasesAddSplitPoints(database: string, req: AddSplitPointsRequest): Promise<AddSplitPointsResponse>

[src]

Adds split points to specified tables and indexes of a database.

@param database

Required. The database on whose tables or indexes the split points are to be added. Values are of the form projects//instances//databases/.

projectsInstancesDatabasesBackupSchedulesCreate(parent: string, req: BackupSchedule, opts?: ProjectsInstancesDatabasesBackupSchedulesCreateOptions): Promise<BackupSchedule>

[src]

Creates a new backup schedule.

@param parent

Required. The name of the database that this backup schedule applies to.

projectsInstancesDatabasesBackupSchedulesDelete(name: string): Promise<Empty>

[src]

Deletes a backup schedule.

@param name

Required. The name of the schedule to delete. Values are of the form projects//instances//databases//backupSchedules/.

projectsInstancesDatabasesBackupSchedulesGet(name: string): Promise<BackupSchedule>

[src]

Gets backup schedule for the input schedule name.

@param name

Required. The name of the schedule to retrieve. Values are of the form projects//instances//databases//backupSchedules/.

projectsInstancesDatabasesBackupSchedulesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

@param resource

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.

projectsInstancesDatabasesBackupSchedulesList(parent: string, opts?: ProjectsInstancesDatabasesBackupSchedulesListOptions): Promise<ListBackupSchedulesResponse>

[src]

Lists all the backup schedules for the database.

@param parent

Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/

projectsInstancesDatabasesBackupSchedulesPatch(name: string, req: BackupSchedule, opts?: ProjectsInstancesDatabasesBackupSchedulesPatchOptions): Promise<BackupSchedule>

[src]

Updates a backup schedule.

@param name

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.

projectsInstancesDatabasesBackupSchedulesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

@param resource

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.

projectsInstancesDatabasesBackupSchedulesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

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.

projectsInstancesDatabasesChangequorum(name: string, req: ChangeQuorumRequest): Promise<Operation>

[src]

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.

@param name

Required. Name of the database in which to apply ChangeQuorum. Values are of the form projects//instances//databases/.

projectsInstancesDatabasesCreate(parent: string, req: CreateDatabaseRequest): Promise<Operation>

[src]

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.

@param parent

Required. The name of the instance that will serve the new database. Values are of the form projects//instances/.

projectsInstancesDatabasesDatabaseRolesList(parent: string, opts?: ProjectsInstancesDatabasesDatabaseRolesListOptions): Promise<ListDatabaseRolesResponse>

[src]

Lists Cloud Spanner database roles.

@param parent

Required. The database whose roles should be listed. Values are of the form projects//instances//databases/.

projectsInstancesDatabasesDatabaseRolesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

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.

projectsInstancesDatabasesDropDatabase(database: string): Promise<Empty>

[src]

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.

@param database

Required. The database to be dropped.

projectsInstancesDatabasesGet(name: string): Promise<Database>

[src]

Gets the state of a Cloud Spanner database.

@param name

Required. The name of the requested database. Values are of the form projects//instances//databases/.

projectsInstancesDatabasesGetDdl(database: string): Promise<GetDatabaseDdlResponse>

[src]

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.

@param database

Required. The database whose schema we wish to get. Values are of the form projects//instances//databases/

projectsInstancesDatabasesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

@param resource

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.

projectsInstancesDatabasesGetScans(name: string, opts?: ProjectsInstancesDatabasesGetScansOptions): Promise<Scan>

[src]

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

@param name

Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface.

projectsInstancesDatabasesList(parent: string, opts?: ProjectsInstancesDatabasesListOptions): Promise<ListDatabasesResponse>

[src]

Lists Cloud Spanner databases.

@param parent

Required. The instance whose databases should be listed. Values are of the form projects//instances/.

projectsInstancesDatabasesOperationsCancel(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsInstancesDatabasesOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsInstancesDatabasesOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsInstancesDatabasesOperationsList(name: string, opts?: ProjectsInstancesDatabasesOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsInstancesDatabasesPatch(name: string, req: Database, opts?: ProjectsInstancesDatabasesPatchOptions): Promise<Operation>

[src]

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.

@param name

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.

projectsInstancesDatabasesRestore(parent: string, req: RestoreDatabaseRequest): Promise<Operation>

[src]

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.

@param parent

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/.

projectsInstancesDatabasesSessionsAdapter(parent: string, req: AdapterSession): Promise<AdapterSession>

[src]

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.

@param parent

Required. The database in which the new session is created.

projectsInstancesDatabasesSessionsAdaptMessage(name: string, req: AdaptMessageRequest): Promise<AdaptMessageResponse>

[src]

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.

@param name

Required. The database session in which the adapter request is processed.

projectsInstancesDatabasesSessionsBatchCreate(database: string, req: BatchCreateSessionsRequest): Promise<BatchCreateSessionsResponse>

[src]

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.

@param database

Required. The database in which the new sessions are created.

projectsInstancesDatabasesSessionsBatchWrite(session: string, req: BatchWriteRequest): Promise<BatchWriteResponse>

[src]

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.

@param session

Required. The session in which the batch request is to be run.

projectsInstancesDatabasesSessionsBeginTransaction(session: string, req: BeginTransactionRequest): Promise<Transaction>

[src]

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

@param session

Required. The session in which the transaction runs.

projectsInstancesDatabasesSessionsCommit(session: string, req: CommitRequest): Promise<CommitResponse>

[src]

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.

@param session

Required. The session in which the transaction to be committed is running.

projectsInstancesDatabasesSessionsCreate(database: string, req: CreateSessionRequest): Promise<Session>

[src]

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

@param database

Required. The database in which the new session is created.

projectsInstancesDatabasesSessionsDelete(name: string): Promise<Empty>

[src]

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

@param name

Required. The name of the session to delete.

projectsInstancesDatabasesSessionsExecuteBatchDml(session: string, req: ExecuteBatchDmlRequest): Promise<ExecuteBatchDmlResponse>

[src]

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.

@param session

Required. The session in which the DML statements should be performed.

projectsInstancesDatabasesSessionsExecuteSql(session: string, req: ExecuteSqlRequest): Promise<ResultSet>

[src]

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).

@param session

Required. The session in which the SQL query should be performed.

projectsInstancesDatabasesSessionsExecuteStreamingSql(session: string, req: ExecuteSqlRequest): Promise<PartialResultSet>

[src]

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).

@param session

Required. The session in which the SQL query should be performed.

projectsInstancesDatabasesSessionsGet(name: string): Promise<Session>

[src]

Gets a session. Returns NOT_FOUND if the session doesn't exist. This is mainly useful for determining whether a session is still alive.

@param name

Required. The name of the session to retrieve.

projectsInstancesDatabasesSessionsList(database: string, opts?: ProjectsInstancesDatabasesSessionsListOptions): Promise<ListSessionsResponse>

[src]

Lists all sessions in a given database.

@param database

Required. The database in which to list sessions.

projectsInstancesDatabasesSessionsPartitionQuery(session: string, req: PartitionQueryRequest): Promise<PartitionResponse>

[src]

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.

@param session

Required. The session used to create the partitions.

projectsInstancesDatabasesSessionsPartitionRead(session: string, req: PartitionReadRequest): Promise<PartitionResponse>

[src]

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.

@param session

Required. The session used to create the partitions.

projectsInstancesDatabasesSessionsRead(session: string, req: ReadRequest): Promise<ResultSet>

[src]

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.

@param session

Required. The session in which the read should be performed.

projectsInstancesDatabasesSessionsRollback(session: string, req: RollbackRequest): Promise<Empty>

[src]

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.

@param session

Required. The session in which the transaction to roll back is running.

projectsInstancesDatabasesSessionsStreamingRead(session: string, req: ReadRequest): Promise<PartialResultSet>

[src]

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.

@param session

Required. The session in which the read should be performed.

projectsInstancesDatabasesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

@param resource

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.

projectsInstancesDatabasesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

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.

projectsInstancesDatabasesUpdateDdl(database: string, req: UpdateDatabaseDdlRequest): Promise<Operation>

[src]

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.

@param database

Required. The database to update.

projectsInstancesDelete(name: string): Promise<Empty>

[src]

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.

@param name

Required. The name of the instance to be deleted. Values are of the form projects//instances/

projectsInstancesGet(name: string, opts?: ProjectsInstancesGetOptions): Promise<Instance>

[src]

Gets information about a particular instance.

@param name

Required. The name of the requested instance. Values are of the form projects//instances/.

projectsInstancesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

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.

@param resource

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.

projectsInstancesInstancePartitionOperationsList(parent: string, opts?: ProjectsInstancesInstancePartitionOperationsListOptions): Promise<ListInstancePartitionOperationsResponse>

[src]

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.

@param parent

Required. The parent instance of the instance partition operations. Values are of the form projects//instances/.

projectsInstancesInstancePartitionsCreate(parent: string, req: CreateInstancePartitionRequest): Promise<Operation>

[src]

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.

@param parent

Required. The name of the instance in which to create the instance partition. Values are of the form projects//instances/.

projectsInstancesInstancePartitionsDelete(name: string, opts?: ProjectsInstancesInstancePartitionsDeleteOptions): Promise<Empty>

[src]

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.

@param name

Required. The name of the instance partition to be deleted. Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}

projectsInstancesInstancePartitionsGet(name: string): Promise<InstancePartition>

[src]

Gets information about a particular instance partition.

@param name

Required. The name of the requested instance partition. Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}.

projectsInstancesInstancePartitionsList(parent: string, opts?: ProjectsInstancesInstancePartitionsListOptions): Promise<ListInstancePartitionsResponse>

[src]

Lists all instance partitions for the given instance.

@param parent

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/-.

projectsInstancesInstancePartitionsOperationsCancel(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsInstancesInstancePartitionsOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsInstancesInstancePartitionsOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsInstancesInstancePartitionsOperationsList(name: string, opts?: ProjectsInstancesInstancePartitionsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsInstancesInstancePartitionsPatch(name: string, req: UpdateInstancePartitionRequest): Promise<Operation>

[src]

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.

@param name

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.

projectsInstancesList(parent: string, opts?: ProjectsInstancesListOptions): Promise<ListInstancesResponse>

[src]

Lists all instances in the given project.

@param parent

Required. The name of the project for which a list of instances is requested. Values are of the form projects/.

projectsInstancesMove(name: string, req: MoveInstanceRequest): Promise<Operation>

[src]

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.

@param name

Required. The instance to move. Values are of the form projects//instances/.

projectsInstancesOperationsCancel(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsInstancesOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsInstancesOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsInstancesOperationsList(name: string, opts?: ProjectsInstancesOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsInstancesPatch(name: string, req: UpdateInstanceRequest): Promise<Operation>

[src]

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.

@param name

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.

projectsInstancesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

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

@param resource

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.

projectsInstancesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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.

@param resource

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.

scansList(parent: string, opts?: ScansListOptions): Promise<ListScansResponse>

[src]

Return available scans given a Database-specific resource name.

@param parent

Required. The unique name of the parent resource, specific to the Database service implementing this interface.