Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::ServiceStub (v1.3.0)

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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_backup

def create_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_backup REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_database

def create_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_database REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_backup

def delete_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_backup REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#drop_database

def drop_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the drop_database REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#restore_database

def restore_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the restore_database REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_database

def update_database(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_database REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)