Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::SqlFlagsService::Client (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::SqlFlagsService::Client.

Client for the SqlFlagsService service.

Service to manage database flags for Cloud SQL instances.

Inherits

  • Object

Methods

.configure

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

Configure the SqlFlagsService 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 SqlFlagsService clients
::Google::Cloud::Sql::V1::SqlFlagsService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the SqlFlagsService 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

#initialize

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

Create a new SqlFlagsService client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::Sql::V1::SqlFlagsService::Client.new do |config|
  config.timeout = 10.0
end

#list

def list(request, options = nil) -> ::Google::Cloud::Sql::V1::FlagsListResponse
def list(database_version: nil, flag_scope: nil) -> ::Google::Cloud::Sql::V1::FlagsListResponse

Lists all available database flags for Cloud SQL instances.

Overloads 
def list(request, options = nil) -> ::Google::Cloud::Sql::V1::FlagsListResponse
Pass arguments to list via a request object, either of type Google::Cloud::Sql::V1::SqlFlagsListRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Sql::V1::SqlFlagsListRequest, ::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 list(database_version: nil, flag_scope: nil) -> ::Google::Cloud::Sql::V1::FlagsListResponse
Pass arguments to list 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
  • database_version (::String) — Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
  • flag_scope (::Google::Cloud::Sql::V1::SqlFlagScope) — Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/sql/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Sql::V1::SqlFlagsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Sql::V1::SqlFlagsListRequest.new

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

# The returned object is of type Google::Cloud::Sql::V1::FlagsListResponse.
p result

#location_client

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

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

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)