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

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

Client for the SqlSslCertsService service.

Service to manage SSL certs for Cloud SQL instances.

Inherits

• Object

Methods

.configure

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

Configure the SqlSslCertsService Client class.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

Example

# Modify the configuration for all SqlSslCertsService clients
::Google::Cloud::Sql::V1::SqlSslCertsService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

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

• config (Client::Configuration)

Returns

• (Client::Configuration)

#delete

def delete(request, options = nil) -> ::Google::Cloud::Sql::V1::Operation
def delete(instance: nil, project: nil, sha1_fingerprint: nil) -> ::Google::Cloud::Sql::V1::Operation

Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.

Overloads

def delete(request, options = nil) -> ::Google::Cloud::Sql::V1::Operation

Pass arguments to delete via a request object, either of type Google::Cloud::Sql::V1::SqlSslCertsDeleteRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Sql::V1::SqlSslCertsDeleteRequest, ::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 delete(instance: nil, project: nil, sha1_fingerprint: nil) -> ::Google::Cloud::Sql::V1::Operation

Pass arguments to delete 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.
• sha1_fingerprint (::String) — Sha1 FingerPrint.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::Sql::V1::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::Sql::V1::Operation)

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::SqlSslCertsService::Client.new

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

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

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

#get

def get(request, options = nil) -> ::Google::Cloud::Sql::V1::SslCert
def get(instance: nil, project: nil, sha1_fingerprint: nil) -> ::Google::Cloud::Sql::V1::SslCert

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

Overloads

def get(request, options = nil) -> ::Google::Cloud::Sql::V1::SslCert

Pass arguments to get via a request object, either of type Google::Cloud::Sql::V1::SqlSslCertsGetRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Sql::V1::SqlSslCertsGetRequest, ::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(instance: nil, project: nil, sha1_fingerprint: nil) -> ::Google::Cloud::Sql::V1::SslCert

Pass arguments to get 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.
• sha1_fingerprint (::String) — Sha1 FingerPrint.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::Sql::V1::SslCert)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::Sql::V1::SslCert)

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::SqlSslCertsService::Client.new

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

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

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

#initialize

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

Create a new SqlSslCertsService client object.

Yields

• (config) — Configure the SqlSslCertsService client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Sql::V1::SqlSslCertsService::Client.new

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

#insert

def insert(request, options = nil) -> ::Google::Cloud::Sql::V1::SslCertsInsertResponse
def insert(instance: nil, project: nil, body: nil) -> ::Google::Cloud::Sql::V1::SslCertsInsertResponse

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

Overloads

def insert(request, options = nil) -> ::Google::Cloud::Sql::V1::SslCertsInsertResponse

Pass arguments to insert via a request object, either of type Google::Cloud::Sql::V1::SqlSslCertsInsertRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Sql::V1::SqlSslCertsInsertRequest, ::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 insert(instance: nil, project: nil, body: nil) -> ::Google::Cloud::Sql::V1::SslCertsInsertResponse

Pass arguments to insert 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.
• body (::Google::Cloud::Sql::V1::SslCertsInsertRequest, ::Hash)

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::Sql::V1::SslCertsInsertResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::Sql::V1::SslCertsInsertResponse)

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::SqlSslCertsService::Client.new

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

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

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

#list

def list(request, options = nil) -> ::Google::Cloud::Sql::V1::SslCertsListResponse
def list(instance: nil, project: nil) -> ::Google::Cloud::Sql::V1::SslCertsListResponse

Lists all of the current SSL certificates for the instance.

Overloads

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

Pass arguments to list via a request object, either of type Google::Cloud::Sql::V1::SqlSslCertsListRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Sql::V1::SqlSslCertsListRequest, ::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(instance: nil, project: nil) -> ::Google::Cloud::Sql::V1::SslCertsListResponse

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

• instance (::String) — Cloud SQL instance ID. This does not include the project ID.
• project (::String) — Project ID of the project that contains the instance.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::Sql::V1::SslCertsListResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::Sql::V1::SslCertsListResponse)

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::SqlSslCertsService::Client.new

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

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

# The returned object is of type Google::Cloud::Sql::V1::SslCertsListResponse.
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)