AlloyDB V1ALPHA API - Class Google::Cloud::AlloyDB::V1alpha::AlloyDBCloudSQLAdmin::Rest::Client (v0.14.1)

Reference documentation and code samples for the AlloyDB V1ALPHA API class Google::Cloud::AlloyDB::V1alpha::AlloyDBCloudSQLAdmin::Rest::Client.

REST client for the AlloyDBCloudSQLAdmin service.

Service for interactions with CloudSQL.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the AlloyDBCloudSQLAdmin Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all AlloyDBCloudSQLAdmin clients
::Google::Cloud::AlloyDB::V1alpha::AlloyDBCloudSQLAdmin::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the AlloyDBCloudSQLAdmin Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new AlloyDBCloudSQLAdmin REST client object.

Yields
  • (config) — Configure the AlloyDBCloudSQLAdmin client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AlloyDB::V1alpha::AlloyDBCloudSQLAdmin::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AlloyDB::V1alpha::AlloyDBCloudSQLAdmin::Rest::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::AlloyDB::V1alpha::AlloyDBCloudSQLAdmin::Rest::Operations

Get the associated client for long-running operations.

Returns

#restore_from_cloud_sql

def restore_from_cloud_sql(request, options = nil) -> ::Gapic::Operation
def restore_from_cloud_sql(cloudsql_backup_run_source: nil, parent: nil, cluster_id: nil, cluster: nil) -> ::Gapic::Operation

Restores an AlloyDB cluster from a CloudSQL resource.

Overloads 
def restore_from_cloud_sql(request, options = nil) -> ::Gapic::Operation
Pass arguments to restore_from_cloud_sql via a request object, either of type RestoreFromCloudSQLRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AlloyDB::V1alpha::RestoreFromCloudSQLRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def restore_from_cloud_sql(cloudsql_backup_run_source: nil, parent: nil, cluster_id: nil, cluster: nil) -> ::Gapic::Operation
Pass arguments to restore_from_cloud_sql via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/alloy_db/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AlloyDB::V1alpha::AlloyDBCloudSQLAdmin::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AlloyDB::V1alpha::RestoreFromCloudSQLRequest.new

# Call the restore_from_cloud_sql method.
result = client.restore_from_cloud_sql request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)