| { |
| "clientLibrary": { |
| "name": "cloud.google.com/go/spanner/admin/database/apiv1", |
| "version": "1.59.0", |
| "language": "GO", |
| "apis": [ |
| { |
| "id": "google.spanner.admin.database.v1", |
| "version": "v1" |
| } |
| ] |
| }, |
| "snippets": [ |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_CancelOperation_sync", |
| "title": "spanner CancelOperation Sample", |
| "description": "CancelOperation is a utility method from google.longrunning.Operations.", |
| "file": "DatabaseAdminClient/CancelOperation/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "CancelOperation", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.CancelOperation", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "longrunningpb.CancelOperationRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "CancelOperation", |
| "fullName": "google.longrunning.Operations.CancelOperation", |
| "service": { |
| "shortName": "Operations", |
| "fullName": "google.longrunning.Operations" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 51, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_CopyBackup_sync", |
| "title": "spanner CopyBackup Sample", |
| "description": "CopyBackup starts copying a Cloud Spanner Backup.\nThe returned backup [long-running operation][google.longrunning.Operation]\nwill have a name of the format\n`projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`\nand can be used to track copying of the backup. The operation is associated\nwith the destination backup.\nThe [metadata][google.longrunning.Operation.metadata] field type is\n[CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].\nThe [response][google.longrunning.Operation.response] field type is\n[Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the\ncopying and delete the backup.\nConcurrent CopyBackup requests can run on the same source backup.", |
| "file": "DatabaseAdminClient/CopyBackup/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "CopyBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.CopyBackup", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.CopyBackupRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "CopyBackupOperation", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "CopyBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 58, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_CreateBackup_sync", |
| "title": "spanner CreateBackup Sample", |
| "description": "CreateBackup starts creating a new Cloud Spanner Backup.\nThe returned backup [long-running operation][google.longrunning.Operation]\nwill have a name of the format\n`projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`\nand can be used to track creation of the backup. The\n[metadata][google.longrunning.Operation.metadata] field type is\n[CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The\n[response][google.longrunning.Operation.response] field type is\n[Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the\ncreation and delete the backup.\nThere can be only one pending backup creation per database. Backup creation\nof different databases can run concurrently.", |
| "file": "DatabaseAdminClient/CreateBackup/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "CreateBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.CreateBackup", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.CreateBackupRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "CreateBackupOperation", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "CreateBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 58, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_CreateDatabase_sync", |
| "title": "spanner CreateDatabase Sample", |
| "description": "CreateDatabase creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned [long-running operation][google.longrunning.Operation] will\nhave a name of the format `<database_name>/operations/<operation_id>` and\ncan be used to track preparation of the database. The\n[metadata][google.longrunning.Operation.metadata] field type is\n[CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The\n[response][google.longrunning.Operation.response] field type is\n[Database][google.spanner.admin.database.v1.Database], if successful.", |
| "file": "DatabaseAdminClient/CreateDatabase/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "CreateDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.CreateDatabase", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.CreateDatabaseRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "CreateDatabaseOperation", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "CreateDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 58, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_DeleteBackup_sync", |
| "title": "spanner DeleteBackup Sample", |
| "description": "DeleteBackup deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].", |
| "file": "DatabaseAdminClient/DeleteBackup/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "DeleteBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.DeleteBackup", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.DeleteBackupRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "DeleteBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 51, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_DeleteOperation_sync", |
| "title": "spanner DeleteOperation Sample", |
| "description": "DeleteOperation is a utility method from google.longrunning.Operations.", |
| "file": "DatabaseAdminClient/DeleteOperation/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "DeleteOperation", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.DeleteOperation", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "longrunningpb.DeleteOperationRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "DeleteOperation", |
| "fullName": "google.longrunning.Operations.DeleteOperation", |
| "service": { |
| "shortName": "Operations", |
| "fullName": "google.longrunning.Operations" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 51, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_DropDatabase_sync", |
| "title": "spanner DropDatabase Sample", |
| "description": "DropDatabase drops (aka deletes) a Cloud Spanner database.\nCompleted backups for the database will be retained according to their\n`expire_time`.\nNote: Cloud Spanner might continue to accept requests for a few seconds\nafter the database has been deleted.", |
| "file": "DatabaseAdminClient/DropDatabase/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "DropDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.DropDatabase", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.DropDatabaseRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "DropDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 51, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_GetBackup_sync", |
| "title": "spanner GetBackup Sample", |
| "description": "GetBackup gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].", |
| "file": "DatabaseAdminClient/GetBackup/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "GetBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.GetBackup", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.GetBackupRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*databasepb.Backup", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "GetBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetBackup", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_GetDatabase_sync", |
| "title": "spanner GetDatabase Sample", |
| "description": "GetDatabase gets the state of a Cloud Spanner database.", |
| "file": "DatabaseAdminClient/GetDatabase/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "GetDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.GetDatabase", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.GetDatabaseRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*databasepb.Database", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "GetDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_GetDatabaseDdl_sync", |
| "title": "spanner GetDatabaseDdl Sample", |
| "description": "GetDatabaseDdl returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the [Operations][google.longrunning.Operations] API.", |
| "file": "DatabaseAdminClient/GetDatabaseDdl/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "GetDatabaseDdl", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.GetDatabaseDdl", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.GetDatabaseDdlRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*databasepb.GetDatabaseDdlResponse", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "GetDatabaseDdl", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_GetIamPolicy_sync", |
| "title": "spanner GetIamPolicy Sample", |
| "description": "GetIamPolicy gets the access control policy for a database or backup resource.\nReturns an empty policy if a database or backup exists but does not have a\npolicy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\n[resource][google.iam.v1.GetIamPolicyRequest.resource].\nFor backups, authorization requires `spanner.backups.getIamPolicy`\npermission on [resource][google.iam.v1.GetIamPolicyRequest.resource].", |
| "file": "DatabaseAdminClient/GetIamPolicy/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "GetIamPolicy", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.GetIamPolicy", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "iampb.GetIamPolicyRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*iampb.Policy", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "GetIamPolicy", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetIamPolicy", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_GetOperation_sync", |
| "title": "spanner GetOperation Sample", |
| "description": "GetOperation is a utility method from google.longrunning.Operations.", |
| "file": "DatabaseAdminClient/GetOperation/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "GetOperation", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.GetOperation", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "longrunningpb.GetOperationRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*longrunningpb.Operation", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "GetOperation", |
| "fullName": "google.longrunning.Operations.GetOperation", |
| "service": { |
| "shortName": "Operations", |
| "fullName": "google.longrunning.Operations" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_ListBackupOperations_sync", |
| "title": "spanner ListBackupOperations Sample", |
| "description": "ListBackupOperations lists the backup [long-running operations][google.longrunning.Operation] in\nthe given instance. A backup operation has a name of the form\n`projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`.\nThe long-running operation\n[metadata][google.longrunning.Operation.metadata] field type\n`metadata.type_url` describes the type of the metadata. Operations returned\ninclude those that have completed/failed/canceled within the last 7 days,\nand pending operations. Operations returned are ordered by\n`operation.metadata.value.progress.start_time` in descending order starting\nfrom the most recently started operation.", |
| "file": "DatabaseAdminClient/ListBackupOperations/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "ListBackupOperations", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.ListBackupOperations", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.ListBackupOperationsRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "OperationIterator", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "ListBackupOperations", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 60, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_ListBackups_sync", |
| "title": "spanner ListBackups Sample", |
| "description": "ListBackups lists completed and pending backups.\nBackups returned are ordered by `create_time` in descending order,\nstarting from the most recent `create_time`.", |
| "file": "DatabaseAdminClient/ListBackups/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "ListBackups", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.ListBackups", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.ListBackupsRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "BackupIterator", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "ListBackups", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListBackups", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 60, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_ListDatabaseOperations_sync", |
| "title": "spanner ListDatabaseOperations Sample", |
| "description": "ListDatabaseOperations lists database [longrunning-operations][google.longrunning.Operation].\nA database operation has a name of the form\n`projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`.\nThe long-running operation\n[metadata][google.longrunning.Operation.metadata] field type\n`metadata.type_url` describes the type of the metadata. Operations returned\ninclude those that have completed/failed/canceled within the last 7 days,\nand pending operations.", |
| "file": "DatabaseAdminClient/ListDatabaseOperations/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "ListDatabaseOperations", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.ListDatabaseOperations", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.ListDatabaseOperationsRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "OperationIterator", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "ListDatabaseOperations", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 60, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_ListDatabaseRoles_sync", |
| "title": "spanner ListDatabaseRoles Sample", |
| "description": "ListDatabaseRoles lists Cloud Spanner database roles.", |
| "file": "DatabaseAdminClient/ListDatabaseRoles/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "ListDatabaseRoles", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.ListDatabaseRoles", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.ListDatabaseRolesRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "DatabaseRoleIterator", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "ListDatabaseRoles", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 60, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_ListDatabases_sync", |
| "title": "spanner ListDatabases Sample", |
| "description": "ListDatabases lists Cloud Spanner databases.", |
| "file": "DatabaseAdminClient/ListDatabases/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "ListDatabases", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.ListDatabases", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.ListDatabasesRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "DatabaseIterator", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "ListDatabases", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 60, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_ListOperations_sync", |
| "title": "spanner ListOperations Sample", |
| "description": "ListOperations is a utility method from google.longrunning.Operations.", |
| "file": "DatabaseAdminClient/ListOperations/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "ListOperations", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.ListOperations", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "longrunningpb.ListOperationsRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "OperationIterator", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "ListOperations", |
| "fullName": "google.longrunning.Operations.ListOperations", |
| "service": { |
| "shortName": "Operations", |
| "fullName": "google.longrunning.Operations" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 60, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_RestoreDatabase_sync", |
| "title": "spanner RestoreDatabase Sample", |
| "description": "RestoreDatabase create a new database by restoring from a completed backup. The new\ndatabase must be in the same project and in an instance with the same\ninstance configuration as the instance containing\nthe backup. The returned database [long-running\noperation][google.longrunning.Operation] has a name of the format\n`projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`,\nand can be used to track the progress of the operation, and to cancel it.\nThe [metadata][google.longrunning.Operation.metadata] field type is\n[RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].\nThe [response][google.longrunning.Operation.response] type\nis [Database][google.spanner.admin.database.v1.Database], if\nsuccessful. Cancelling the returned operation will stop the restore and\ndelete the database.\nThere can be only one database being restored into an instance at a time.\nOnce the restore operation completes, a new restore operation can be\ninitiated, without waiting for the optimize operation associated with the\nfirst restore to complete.", |
| "file": "DatabaseAdminClient/RestoreDatabase/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "RestoreDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.RestoreDatabase", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.RestoreDatabaseRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "RestoreDatabaseOperation", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "RestoreDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 58, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_SetIamPolicy_sync", |
| "title": "spanner SetIamPolicy Sample", |
| "description": "SetIamPolicy sets the access control policy on a database or backup resource.\nReplaces any existing policy.\n\nAuthorization requires `spanner.databases.setIamPolicy`\npermission on [resource][google.iam.v1.SetIamPolicyRequest.resource].\nFor backups, authorization requires `spanner.backups.setIamPolicy`\npermission on [resource][google.iam.v1.SetIamPolicyRequest.resource].", |
| "file": "DatabaseAdminClient/SetIamPolicy/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "SetIamPolicy", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.SetIamPolicy", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "iampb.SetIamPolicyRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*iampb.Policy", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "SetIamPolicy", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.SetIamPolicy", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_TestIamPermissions_sync", |
| "title": "spanner TestIamPermissions Sample", |
| "description": "TestIamPermissions returns permissions that the caller has on the specified database or backup\nresource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will\nresult in a NOT_FOUND error if the user has\n`spanner.databases.list` permission on the containing Cloud\nSpanner instance. Otherwise returns an empty set of permissions.\nCalling this method on a backup that does not exist will\nresult in a NOT_FOUND error if the user has\n`spanner.backups.list` permission on the containing instance.", |
| "file": "DatabaseAdminClient/TestIamPermissions/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "TestIamPermissions", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.TestIamPermissions", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "iampb.TestIamPermissionsRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*iampb.TestIamPermissionsResponse", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "TestIamPermissions", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.TestIamPermissions", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_UpdateBackup_sync", |
| "title": "spanner UpdateBackup Sample", |
| "description": "UpdateBackup updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].", |
| "file": "DatabaseAdminClient/UpdateBackup/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "UpdateBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.UpdateBackup", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.UpdateBackupRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "*databasepb.Backup", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "UpdateBackup", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 53, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_UpdateDatabase_sync", |
| "title": "spanner UpdateDatabase Sample", |
| "description": "UpdateDatabase updates a Cloud Spanner database. The returned\n[long-running operation][google.longrunning.Operation] can be used to track\nthe progress of updating the database. If the named database does not\nexist, returns `NOT_FOUND`.\n\nWhile the operation is pending: \n\n* The database's\n[reconciling][google.spanner.admin.database.v1.Database.reconciling]\nfield is set to true.\n* Cancelling the operation is best-effort. If the cancellation succeeds,\nthe operation metadata's\n[cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time]\nis set, the updates are reverted, and the operation terminates with a\n`CANCELLED` status.\n* New UpdateDatabase requests will return a `FAILED_PRECONDITION` error\nuntil the pending operation is done (returns successfully or with\nerror).\n* Reading the database via the API continues to give the pre-request\nvalues.\n\nUpon completion of the returned operation: \n\n* The new values are in effect and readable via the API.\n* The database's\n[reconciling][google.spanner.admin.database.v1.Database.reconciling]\nfield becomes false.\n\nThe returned [long-running operation][google.longrunning.Operation] will\nhave a name of the format\n`projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`\nand can be used to track the database modification. The\n[metadata][google.longrunning.Operation.metadata] field type is\n[UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata].\nThe [response][google.longrunning.Operation.response] field type is\n[Database][google.spanner.admin.database.v1.Database], if successful.", |
| "file": "DatabaseAdminClient/UpdateDatabase/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "UpdateDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.UpdateDatabase", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.UpdateDatabaseRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "UpdateDatabaseOperation", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "UpdateDatabase", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabase", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 58, |
| "type": "FULL" |
| } |
| ] |
| }, |
| { |
| "regionTag": "spanner_v1_generated_DatabaseAdmin_UpdateDatabaseDdl_sync", |
| "title": "spanner UpdateDatabaseDdl Sample", |
| "description": "UpdateDatabaseDdl updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\n[long-running operation][google.longrunning.Operation] will have a name of\nthe format `<database_name>/operations/<operation_id>` and can be used to\ntrack execution of the schema change(s). The\n[metadata][google.longrunning.Operation.metadata] field type is\n[UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.", |
| "file": "DatabaseAdminClient/UpdateDatabaseDdl/main.go", |
| "language": "GO", |
| "clientMethod": { |
| "shortName": "UpdateDatabaseDdl", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient.UpdateDatabaseDdl", |
| "parameters": [ |
| { |
| "type": "context.Context", |
| "name": "ctx" |
| }, |
| { |
| "type": "databasepb.UpdateDatabaseDdlRequest", |
| "name": "req" |
| }, |
| { |
| "type": "...gax.CallOption", |
| "name": "opts" |
| } |
| ], |
| "resultType": "UpdateDatabaseDdlOperation", |
| "client": { |
| "shortName": "DatabaseAdminClient", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdminClient" |
| }, |
| "method": { |
| "shortName": "UpdateDatabaseDdl", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl", |
| "service": { |
| "shortName": "DatabaseAdmin", |
| "fullName": "google.spanner.admin.database.v1.DatabaseAdmin" |
| } |
| } |
| }, |
| "origin": "API_DEFINITION", |
| "segments": [ |
| { |
| "start": 18, |
| "end": 56, |
| "type": "FULL" |
| } |
| ] |
| } |
| ] |
| } |
