Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::ServiceStub.
REST service stub for the DatabaseAdmin service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#copy_backup
def copy_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the copy_backup REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::CopyBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_backup
def create_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_backup REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_backup_schedule
def create_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule
Baseline implementation for the create_backup_schedule REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_database
def create_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_database REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_backup
def delete_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_backup REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::DeleteBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_backup_schedule
def delete_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_backup_schedule REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::DeleteBackupScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#drop_database
def drop_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the drop_database REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::DropDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#get_backup
def get_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::Backup
Baseline implementation for the get_backup REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::GetBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::Backup)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::Backup) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_backup_schedule
def get_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule
Baseline implementation for the get_backup_schedule REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::GetBackupScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_database
def get_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::Database
Baseline implementation for the get_database REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::Database)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::Database) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_database_ddl
def get_database_ddl(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse
Baseline implementation for the get_database_ddl REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_iam_policy
def get_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy
Baseline implementation for the get_iam_policy REST call
- request_pb (::Google::Iam::V1::GetIamPolicyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_backup_operations
def list_backup_operations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse
Baseline implementation for the list_backup_operations REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_backup_schedules
def list_backup_schedules(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupSchedulesResponse
Baseline implementation for the list_backup_schedules REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupSchedulesRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupSchedulesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupSchedulesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_backups
def list_backups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse
Baseline implementation for the list_backups REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_database_operations
def list_database_operations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse
Baseline implementation for the list_database_operations REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_database_roles
def list_database_roles(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse
Baseline implementation for the list_database_roles REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_databases
def list_databases(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse
Baseline implementation for the list_databases REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#restore_database
def restore_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the restore_database REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#set_iam_policy
def set_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy
Baseline implementation for the set_iam_policy REST call
- request_pb (::Google::Iam::V1::SetIamPolicyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply
- (::ArgumentError)
#test_iam_permissions
def test_iam_permissions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::TestIamPermissionsResponse
Baseline implementation for the test_iam_permissions REST call
- request_pb (::Google::Iam::V1::TestIamPermissionsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::TestIamPermissionsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_backup
def update_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::Backup
Baseline implementation for the update_backup REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::UpdateBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::Backup)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::Backup) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_backup_schedule
def update_backup_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule
Baseline implementation for the update_backup_schedule REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::UpdateBackupScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_database
def update_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_database REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_database_ddl
def update_database_ddl(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_database_ddl REST call
- request_pb (::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)