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

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

REST client for the SqlOperationsService service.

Service to fetch operations for database instances.

Inherits

  • Object

Methods

.configure

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

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

#cancel

def cancel(request, options = nil) -> ::Google::Protobuf::Empty
def cancel(operation: nil, project: nil) -> ::Google::Protobuf::Empty

Cancels an instance operation that has been performed on an instance.

Overloads 
def cancel(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel via a request object, either of type Google::Cloud::Sql::V1::SqlOperationsCancelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Sql::V1::SqlOperationsCancelRequest, ::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 cancel(operation: nil, project: nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel 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
  • operation (::String) — Instance operation ID.
  • project (::String) — Project ID of the project that contains the instance.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::SqlOperationsService::Rest::Client.new

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

#configure

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

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

#get

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

Retrieves an instance operation that has been performed on an instance.

Overloads 
def get(request, options = nil) -> ::Google::Cloud::Sql::V1::Operation
Pass arguments to get via a request object, either of type Google::Cloud::Sql::V1::SqlOperationsGetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Sql::V1::SqlOperationsGetRequest, ::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(operation: nil, project: nil) -> ::Google::Cloud::Sql::V1::Operation
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
  • operation (::String) — Required. Instance operation ID.
  • project (::String) — Required. Project ID of the project that contains the instance.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::SqlOperationsService::Rest::Client.new

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

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

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

#initialize

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

Create a new SqlOperationsService REST client object.

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

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

#list

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

Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

Overloads 
def list(request, options = nil) -> ::Google::Cloud::Sql::V1::OperationsListResponse
Pass arguments to list via a request object, either of type Google::Cloud::Sql::V1::SqlOperationsListRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Sql::V1::SqlOperationsListRequest, ::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, max_results: nil, page_token: nil, project: nil) -> ::Google::Cloud::Sql::V1::OperationsListResponse
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.
  • max_results (::Integer) — Maximum number of operations per response.
  • page_token (::String) — A previously-returned page token representing part of the larger set of results to view.
  • project (::String) — Project ID of the project that contains the instance.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::SqlOperationsService::Rest::Client.new

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

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

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

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)