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

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

Client for the SqlConnectService service.

Cloud SQL connect service.

Inherits

  • Object

Methods

.configure

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

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

#configure

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

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

#generate_ephemeral_cert

def generate_ephemeral_cert(request, options = nil) -> ::Google::Cloud::Sql::V1::GenerateEphemeralCertResponse
def generate_ephemeral_cert(instance: nil, project: nil, public_key: nil, access_token: nil, read_time: nil, valid_duration: nil) -> ::Google::Cloud::Sql::V1::GenerateEphemeralCertResponse

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

Overloads 
def generate_ephemeral_cert(request, options = nil) -> ::Google::Cloud::Sql::V1::GenerateEphemeralCertResponse
Pass arguments to generate_ephemeral_cert via a request object, either of type GenerateEphemeralCertRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Sql::V1::GenerateEphemeralCertRequest, ::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 generate_ephemeral_cert(instance: nil, project: nil, public_key: nil, access_token: nil, read_time: nil, valid_duration: nil) -> ::Google::Cloud::Sql::V1::GenerateEphemeralCertResponse
Pass arguments to generate_ephemeral_cert 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
  • instance (::String) — Cloud SQL instance ID. This does not include the project ID.
  • project (::String) — Project ID of the project that contains the instance.
  • public_key (::String) — PEM encoded public key to include in the signed certificate.
  • access_token (::String) — Optional. Access token to include in the signed certificate.
  • read_time (::Google::Protobuf::Timestamp, ::Hash) — Optional. Optional snapshot read timestamp to trade freshness for performance.
  • valid_duration (::Google::Protobuf::Duration, ::Hash) — Optional. If set, it will contain the cert valid duration.
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::SqlConnectService::Client.new

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

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

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

#get_connect_settings

def get_connect_settings(request, options = nil) -> ::Google::Cloud::Sql::V1::ConnectSettings
def get_connect_settings(instance: nil, project: nil, read_time: nil) -> ::Google::Cloud::Sql::V1::ConnectSettings

Retrieves connect settings about a Cloud SQL instance.

Overloads 
def get_connect_settings(request, options = nil) -> ::Google::Cloud::Sql::V1::ConnectSettings
Pass arguments to get_connect_settings via a request object, either of type GetConnectSettingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Sql::V1::GetConnectSettingsRequest, ::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 get_connect_settings(instance: nil, project: nil, read_time: nil) -> ::Google::Cloud::Sql::V1::ConnectSettings
Pass arguments to get_connect_settings 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
  • instance (::String) — Cloud SQL instance ID. This does not include the project ID.
  • project (::String) — Project ID of the project that contains the instance.
  • read_time (::Google::Protobuf::Timestamp, ::Hash) — Optional. Optional snapshot read timestamp to trade freshness for performance.
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::SqlConnectService::Client.new

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

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

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

#initialize

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

Create a new SqlConnectService client object.

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

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

#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)