AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::ServiceStub (v0.10.0)

Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::ServiceStub.

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

Inherits

  • Object

Methods

#batch_create_instances

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

Baseline implementation for the batch_create_instances 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
  • request_pb (::Google::Cloud::AlloyDB::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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_cluster

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

Baseline implementation for the create_cluster REST call

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

#create_instance

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

Baseline implementation for the create_instance REST call

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

#create_secondary_cluster

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

Baseline implementation for the create_secondary_cluster REST call

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

#create_secondary_instance

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

Baseline implementation for the create_secondary_instance REST call

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

#create_user

def create_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::User

Baseline implementation for the create_user REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::CreateUserRequest) — 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)

#delete_backup

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

Baseline implementation for the delete_backup REST call

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

#delete_cluster

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

Baseline implementation for the delete_cluster REST call

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

#delete_instance

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

Baseline implementation for the delete_instance REST call

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

#delete_user

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

Baseline implementation for the delete_user REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::DeleteUserRequest) — 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)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#execute_sql

def execute_sql(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ExecuteSqlResponse

Baseline implementation for the execute_sql REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::ExecuteSqlRequest) — 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)

#failover_instance

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

Baseline implementation for the failover_instance REST call

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

#generate_client_certificate

def generate_client_certificate(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse

Baseline implementation for the generate_client_certificate REST call

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

#get_backup

def get_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::Backup

Baseline implementation for the get_backup REST call

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

#get_cluster

def get_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::Cluster

Baseline implementation for the get_cluster REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::GetClusterRequest) — 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)

#get_connection_info

def get_connection_info(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ConnectionInfo

Baseline implementation for the get_connection_info REST call

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

#get_instance

def get_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::Instance

Baseline implementation for the get_instance REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::GetInstanceRequest) — 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)

#get_user

def get_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::User

Baseline implementation for the get_user REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::GetUserRequest) — 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)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#inject_fault

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

Baseline implementation for the inject_fault REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::InjectFaultRequest) — 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_backups

def list_backups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListBackupsResponse

Baseline implementation for the list_backups REST call

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

#list_clusters

def list_clusters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListClustersResponse

Baseline implementation for the list_clusters REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::ListClustersRequest) — 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_databases

def list_databases(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::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)

#list_instances

def list_instances(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListInstancesResponse

Baseline implementation for the list_instances REST call

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

#list_supported_database_flags

def list_supported_database_flags(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListSupportedDatabaseFlagsResponse

Baseline implementation for the list_supported_database_flags REST call

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

#list_users

def list_users(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListUsersResponse

Baseline implementation for the list_users REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::ListUsersRequest) — 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)

#promote_cluster

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

Baseline implementation for the promote_cluster REST call

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

#restart_instance

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

Baseline implementation for the restart_instance REST call

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

#restore_cluster

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

Baseline implementation for the restore_cluster REST call

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

#switchover_cluster

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

Baseline implementation for the switchover_cluster 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_backup

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

Baseline implementation for the update_backup REST call

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

#update_cluster

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

Baseline implementation for the update_cluster REST call

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

#update_instance

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

Baseline implementation for the update_instance REST call

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

#update_user

def update_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::User

Baseline implementation for the update_user REST call

Parameters
  • request_pb (::Google::Cloud::AlloyDB::V1::UpdateUserRequest) — 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)