Cloud SQL Admin V1BETA4 API - Class Google::Cloud::Sql::V1beta4::SqlInstancesService::Rest::ServiceStub (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1BETA4 API class Google::Cloud::Sql::V1beta4::SqlInstancesService::Rest::ServiceStub.

REST service stub for the SqlInstancesService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#acquire_ssrs_lease

def acquire_ssrs_lease(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::SqlInstancesAcquireSsrsLeaseResponse

Baseline implementation for the acquire_ssrs_lease REST call

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

#add_entra_id_certificate

def add_entra_id_certificate(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the add_entra_id_certificate REST call

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

#add_server_ca

def add_server_ca(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the add_server_ca REST call

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

#add_server_certificate

def add_server_certificate(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the add_server_certificate REST call

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

#call_clone

def call_clone(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the call_clone REST call

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

#create_ephemeral

def create_ephemeral(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::SslCert

Baseline implementation for the create_ephemeral REST call

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

#delete

def delete(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the delete REST call

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

#demote

def demote(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the demote REST call

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

#demote_master

def demote_master(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the demote_master 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)

#execute_sql

def execute_sql(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::SqlInstancesExecuteSqlResponse

Baseline implementation for the execute_sql REST call

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

#export

def export(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the export REST call

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

#failover

def failover(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the failover REST call

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

#get

def get(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::DatabaseInstance

Baseline implementation for the get REST call

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

#get_disk_shrink_config

def get_disk_shrink_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::SqlInstancesGetDiskShrinkConfigResponse

Baseline implementation for the get_disk_shrink_config REST call

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

#get_latest_recovery_time

def get_latest_recovery_time(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::SqlInstancesGetLatestRecoveryTimeResponse

Baseline implementation for the get_latest_recovery_time REST call

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

#import

def import(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the import REST call

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

#insert

def insert(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the insert REST call

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

#list

def list(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::InstancesListResponse

Baseline implementation for the list REST call

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

#list_entra_id_certificates

def list_entra_id_certificates(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::InstancesListEntraIdCertificatesResponse

Baseline implementation for the list_entra_id_certificates REST call

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

#list_server_cas

def list_server_cas(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::InstancesListServerCasResponse

Baseline implementation for the list_server_cas REST call

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

#list_server_certificates

def list_server_certificates(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::InstancesListServerCertificatesResponse

Baseline implementation for the list_server_certificates 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)

#patch

def patch(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the patch REST call

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

#perform_disk_shrink

def perform_disk_shrink(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the perform_disk_shrink REST call

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

#point_in_time_restore

def point_in_time_restore(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the point_in_time_restore REST call

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

#pre_check_major_version_upgrade

def pre_check_major_version_upgrade(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the pre_check_major_version_upgrade REST call

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

#promote_replica

def promote_replica(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the promote_replica REST call

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

#reencrypt

def reencrypt(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the reencrypt REST call

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

#release_ssrs_lease

def release_ssrs_lease(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::SqlInstancesReleaseSsrsLeaseResponse

Baseline implementation for the release_ssrs_lease REST call

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

#reschedule_maintenance

def reschedule_maintenance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the reschedule_maintenance REST call

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

#reset_replica_size

def reset_replica_size(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the reset_replica_size REST call

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

#reset_ssl_config

def reset_ssl_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the reset_ssl_config REST call

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

#restart

def restart(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the restart REST call

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

#restore_backup

def restore_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the restore_backup REST call

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

#rotate_entra_id_certificate

def rotate_entra_id_certificate(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the rotate_entra_id_certificate REST call

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

#rotate_server_ca

def rotate_server_ca(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the rotate_server_ca REST call

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

#rotate_server_certificate

def rotate_server_certificate(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the rotate_server_certificate REST call

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

#start_external_sync

def start_external_sync(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the start_external_sync REST call

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

#start_replica

def start_replica(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the start_replica REST call

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

#stop_replica

def stop_replica(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the stop_replica REST call

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

#switchover

def switchover(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the switchover REST call

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

#truncate_log

def truncate_log(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the truncate_log REST call

Parameters
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

def update(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::Operation

Baseline implementation for the update REST call

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

#verify_external_sync_settings

def verify_external_sync_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Sql::V1beta4::SqlInstancesVerifyExternalSyncSettingsResponse

Baseline implementation for the verify_external_sync_settings REST call

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