Class: Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client

Inherits:

Object

Object
Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client

show all

Includes:: Paths

Defined in:: lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb

Overview

Client for the AlloyDBAdmin service.

Service describing handlers for resources

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client readonly
Get the associated client for mix-in of the IAMPolicy.
#location_client ⇒ Google::Cloud::Location::Locations::Client readonly
Get the associated client for mix-in of the Locations.
#operations_client ⇒ ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Operations readonly
Get the associated client for long-running operations.

Class Method Summary collapse

.configure {|config| ... } ⇒ Client::Configuration
Configure the AlloyDBAdmin Client class.

Instance Method Summary collapse

#batch_create_instances(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates new instances under the given project, location and cluster.
#configure {|config| ... } ⇒ Client::Configuration
Configure the AlloyDBAdmin Client instance.
#create_backup(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a new Backup in a given project and location.
#create_cluster(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a new Cluster in a given project and location.
#create_instance(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a new Instance in a given project and location.
#delete_backup(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a single Backup.
#delete_cluster(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a single Cluster.
#delete_instance(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a single Instance.
#failover_instance(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Forces a Failover for a highly available instance.
#get_backup(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AlloyDB::V1::Backup
Gets details of a single Backup.
#get_cluster(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AlloyDB::V1::Cluster
Gets details of a single Cluster.
#get_instance(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AlloyDB::V1::Instance
Gets details of a single Instance.
#initialize {|config| ... } ⇒ Client constructor
Create a new AlloyDBAdmin client object.
#list_backups(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>
Lists Backups in a given project and location.
#list_clusters(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>
Lists Clusters in a given project and location.
#list_instances(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>
Lists Instances in a given project and location.
#list_supported_database_flags(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>
Lists SupportedDatabaseFlags for a given project and location.
#restart_instance(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Restart an Instance in a cluster.
#restore_cluster(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
#update_backup(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the parameters of a single Backup.
#update_cluster(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the parameters of a single Cluster.
#update_instance(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the parameters of a single Instance.

Methods included from Paths

#backup_path, #cluster_path, #crypto_key_version_path, #instance_path, #location_path, #network_path

Constructor Details

#initialize {|config| ... } ⇒ `Client`

Create a new AlloyDBAdmin client object.

Examples:


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

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

Yields:

(config) —
Configure the AlloyDBAdmin client.

Yield Parameters:

config (Client::Configuration)

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 148

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/alloydb/v1/service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @alloy_db_admin_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#iam_policy_client ⇒ `Google::Iam::V1::IAMPolicy::Client` (readonly)

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

Returns:

(Google::Iam::V1::IAMPolicy::Client)



221
222
223

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 221

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ `Google::Cloud::Location::Locations::Client` (readonly)

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

Returns:

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



214
215
216

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 214

def location_client
  @location_client
end

#operations_client ⇒ `::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Operations` (readonly)

Get the associated client for long-running operations.

Returns:

(::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Operations)



207
208
209

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 207

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ `Client::Configuration`

Configure the AlloyDBAdmin Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 58

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "AlloyDB", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0

    default_config.rpcs.list_clusters.timeout = 60.0
    default_config.rpcs.list_clusters.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_cluster.timeout = 60.0
    default_config.rpcs.get_cluster.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_instances.timeout = 60.0
    default_config.rpcs.list_instances.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_instance.timeout = 60.0
    default_config.rpcs.get_instance.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_backups.timeout = 60.0
    default_config.rpcs.list_backups.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_backup.timeout = 60.0
    default_config.rpcs.get_backup.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_supported_database_flags.timeout = 60.0
    default_config.rpcs.list_supported_database_flags.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_create_instances(request, options = nil) ⇒ `::Gapic::Operation` #batch_create_instances(parent: nil, requests: nil, request_id: nil) ⇒ `::Gapic::Operation`

Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the batch_create_instances method.
result = client.batch_create_instances 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

Overloads:

#batch_create_instances(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to batch_create_instances via a request object, either of type BatchCreateInstancesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::BatchCreateInstancesRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#batch_create_instances(parent: nil, requests: nil, request_id: nil) ⇒ ::Gapic::Operation

Pass arguments to batch_create_instances 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:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent resource.
- requests (::Google::Cloud::AlloyDB::V1::CreateInstanceRequests, ::Hash) (defaults to: nil) —
  Required. Resources being created.
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1270

def batch_create_instances request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::BatchCreateInstancesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_create_instances.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_create_instances.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_create_instances.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :batch_create_instances, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ `Client::Configuration`

Configure the AlloyDBAdmin 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 configure.

See Configuration for a description of the configuration fields.

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 127

def configure
  yield @config if block_given?
  @config
end

#create_backup(request, options = nil) ⇒ `::Gapic::Operation` #create_backup(parent: nil, backup_id: nil, backup: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Creates a new Backup in a given project and location.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the create_backup method.
result = client.create_backup 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

Overloads:

#create_backup(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to create_backup via a request object, either of type CreateBackupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::CreateBackupRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_backup(parent: nil, backup_id: nil, backup: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to create_backup 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:
- parent (::String) (defaults to: nil) —
  Required. Value for parent.
- backup_id (::String) (defaults to: nil) —
  Required. ID of the requesting object.
- backup (::Google::Cloud::AlloyDB::V1::Backup, ::Hash) (defaults to: nil) —
  Required. The resource being created
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, the backend validates the request, but doesn't actually execute it.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2028

def create_backup request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::CreateBackupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_backup.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_backup.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_backup.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :create_backup, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_cluster(request, options = nil) ⇒ `::Gapic::Operation` #create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Creates a new Cluster in a given project and location.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the create_cluster method.
result = client.create_cluster 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

Overloads:

#create_cluster(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to create_cluster via a request object, either of type CreateClusterRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::CreateClusterRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to create_cluster 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:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
- cluster_id (::String) (defaults to: nil) —
  Required. ID of the requesting object.
- cluster (::Google::Cloud::AlloyDB::V1::Cluster, ::Hash) (defaults to: nil) —
  Required. The resource being created
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 487

def create_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::CreateClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :create_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_instance(request, options = nil) ⇒ `::Gapic::Operation` #create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Creates a new Instance in a given project and location.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the create_instance method.
result = client.create_instance 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

Overloads:

#create_instance(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to create_instance via a request object, either of type CreateInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::CreateInstanceRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to create_instance 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:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
- instance_id (::String) (defaults to: nil) —
  Required. ID of the requesting object.
- instance (::Google::Cloud::AlloyDB::V1::Instance, ::Hash) (defaults to: nil) —
  Required. The resource being created
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1152

def create_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::CreateInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_instance.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :create_instance, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_backup(request, options = nil) ⇒ `::Gapic::Operation` #delete_backup(name: nil, request_id: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

Deletes a single Backup.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the delete_backup method.
result = client.delete_backup 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

Overloads:

#delete_backup(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_backup via a request object, either of type DeleteBackupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::DeleteBackupRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_backup(name: nil, request_id: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_backup 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:
- name (::String) (defaults to: nil) —
  Required. Name of the resource. For the required format, see the comment on the Backup.name field.
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, the backend validates the request, but doesn't actually execute it.
- etag (::String) (defaults to: nil) —
  Optional. The current etag of the Backup. If an etag is provided and does not match the current etag of the Backup, deletion will be blocked and an ABORTED error will be returned.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2262

def delete_backup request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::DeleteBackupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_backup.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_backup.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_backup.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :delete_backup, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_cluster(request, options = nil) ⇒ `::Gapic::Operation` #delete_cluster(name: nil, request_id: nil, etag: nil, validate_only: nil, force: nil) ⇒ `::Gapic::Operation`

Deletes a single Cluster.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the delete_cluster method.
result = client.delete_cluster 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

Overloads:

#delete_cluster(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_cluster via a request object, either of type DeleteClusterRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::DeleteClusterRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_cluster(name: nil, request_id: nil, etag: nil, validate_only: nil, force: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_cluster 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:
- name (::String) (defaults to: nil) —
  Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- etag (::String) (defaults to: nil) —
  Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
- force (::Boolean) (defaults to: nil) —
  Optional. Whether to cascade delete child instances for given cluster.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 724

def delete_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::DeleteClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :delete_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_instance(request, options = nil) ⇒ `::Gapic::Operation` #delete_instance(name: nil, request_id: nil, etag: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Deletes a single Instance.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the delete_instance method.
result = client.delete_instance 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

Overloads:

#delete_instance(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_instance via a request object, either of type DeleteInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::DeleteInstanceRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_instance(name: nil, request_id: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_instance 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:
- name (::String) (defaults to: nil) —
  Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- etag (::String) (defaults to: nil) —
  Optional. The current etag of the Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned.
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1505

def delete_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::DeleteInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_instance.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :delete_instance, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#failover_instance(request, options = nil) ⇒ `::Gapic::Operation` #failover_instance(name: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the failover_instance method.
result = client.failover_instance 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

Overloads:

#failover_instance(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to failover_instance via a request object, either of type FailoverInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::FailoverInstanceRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#failover_instance(name: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to failover_instance 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:
- name (::String) (defaults to: nil) —
  Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1618

def failover_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::FailoverInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.failover_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.failover_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.failover_instance.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :failover_instance, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_backup(request, options = nil) ⇒ `::Google::Cloud::AlloyDB::V1::Backup` #get_backup(name: nil) ⇒ `::Google::Cloud::AlloyDB::V1::Backup`

Gets details of a single Backup.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

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

# The returned object is of type Google::Cloud::AlloyDB::V1::Backup.
p result

Overloads:

#get_backup(request, options = nil) ⇒ ::Google::Cloud::AlloyDB::V1::Backup

Pass arguments to get_backup via a request object, either of type GetBackupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::GetBackupRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_backup(name: nil) ⇒ ::Google::Cloud::AlloyDB::V1::Backup

Pass arguments to get_backup 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:
- name (::String) (defaults to: nil) —
  Required. Name of the resource

Yields:

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

Yield Parameters:

response (::Google::Cloud::AlloyDB::V1::Backup)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AlloyDB::V1::Backup)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1915

def get_backup request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::GetBackupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_backup.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_backup.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_backup.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :get_backup, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_cluster(request, options = nil) ⇒ `::Google::Cloud::AlloyDB::V1::Cluster` #get_cluster(name: nil) ⇒ `::Google::Cloud::AlloyDB::V1::Cluster`

Gets details of a single Cluster.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

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

# The returned object is of type Google::Cloud::AlloyDB::V1::Cluster.
p result

Overloads:

#get_cluster(request, options = nil) ⇒ ::Google::Cloud::AlloyDB::V1::Cluster

Pass arguments to get_cluster via a request object, either of type GetClusterRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::GetClusterRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_cluster(name: nil) ⇒ ::Google::Cloud::AlloyDB::V1::Cluster

Pass arguments to get_cluster 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:
- name (::String) (defaults to: nil) —
  Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

Yields:

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

Yield Parameters:

response (::Google::Cloud::AlloyDB::V1::Cluster)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AlloyDB::V1::Cluster)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 372

def get_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::GetClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :get_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_instance(request, options = nil) ⇒ `::Google::Cloud::AlloyDB::V1::Instance` #get_instance(name: nil, view: nil) ⇒ `::Google::Cloud::AlloyDB::V1::Instance`

Gets details of a single Instance.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

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

# The returned object is of type Google::Cloud::AlloyDB::V1::Instance.
p result

Overloads:

#get_instance(request, options = nil) ⇒ ::Google::Cloud::AlloyDB::V1::Instance

Pass arguments to get_instance via a request object, either of type GetInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::GetInstanceRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_instance(name: nil, view: nil) ⇒ ::Google::Cloud::AlloyDB::V1::Instance

Pass arguments to get_instance 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:
- name (::String) (defaults to: nil) —
  Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- view (::Google::Cloud::AlloyDB::V1::InstanceView) (defaults to: nil) —
  The view of the instance to return.

Yields:

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

Yield Parameters:

response (::Google::Cloud::AlloyDB::V1::Instance)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AlloyDB::V1::Instance)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1037

def get_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::GetInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_instance.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :get_instance, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_backups(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>` #list_backups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>`

Lists Backups in a given project and location.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AlloyDB::V1::Backup.
  p item
end

Overloads:

#list_backups(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>

Pass arguments to list_backups via a request object, either of type ListBackupsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::ListBackupsRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_backups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>

Pass arguments to list_backups 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:
- parent (::String) (defaults to: nil) —
  Required. Parent value for ListBackupsRequest
- page_size (::Integer) (defaults to: nil) —
  Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- page_token (::String) (defaults to: nil) —
  A token identifying a page of results the server should return.
- filter (::String) (defaults to: nil) —
  Filtering results
- order_by (::String) (defaults to: nil) —
  Hint for how to order the results

Yields:

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

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1829

def list_backups request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::ListBackupsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_backups.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_backups.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_backups.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :list_backups, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @alloy_db_admin_stub, :list_backups, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_clusters(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>` #list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>`

Lists Clusters in a given project and location.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AlloyDB::V1::Cluster.
  p item
end

Overloads:

#list_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>

Pass arguments to list_clusters via a request object, either of type ListClustersRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::ListClustersRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>

Pass arguments to list_clusters 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:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:
  - projects/{project}/locations/-
- page_size (::Integer) (defaults to: nil) —
  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- page_token (::String) (defaults to: nil) —
  A token identifying a page of results the server should return.
- filter (::String) (defaults to: nil) —
  Optional. Filtering results
- order_by (::String) (defaults to: nil) —
  Optional. Hint for how to order the results

Yields:

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

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 285

def list_clusters request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::ListClustersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_clusters.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_clusters.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_clusters.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :list_clusters, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @alloy_db_admin_stub, :list_clusters, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_instances(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>` #list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>`

Lists Instances in a given project and location.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AlloyDB::V1::Instance.
  p item
end

Overloads:

#list_instances(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>

Pass arguments to list_instances via a request object, either of type ListInstancesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::ListInstancesRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>

Pass arguments to list_instances 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:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:
  - projects/{project}/locations/-/clusters/-
  - projects/{project}/locations/{region}/clusters/-
- page_size (::Integer) (defaults to: nil) —
  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- page_token (::String) (defaults to: nil) —
  A token identifying a page of results the server should return.
- filter (::String) (defaults to: nil) —
  Optional. Filtering results
- order_by (::String) (defaults to: nil) —
  Optional. Hint for how to order the results

Yields:

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

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 948

def list_instances request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::ListInstancesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_instances.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_instances.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_instances.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :list_instances, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @alloy_db_admin_stub, :list_instances, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_supported_database_flags(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>` #list_supported_database_flags(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>`

Lists SupportedDatabaseFlags for a given project and location.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag.
  p item
end

Overloads:

#list_supported_database_flags(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>

Pass arguments to list_supported_database_flags via a request object, either of type ListSupportedDatabaseFlagsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::ListSupportedDatabaseFlagsRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_supported_database_flags(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>

Pass arguments to list_supported_database_flags 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:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent resource. The required format is:
  - projects/{project}/locations/{location}
  Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags.
- page_size (::Integer) (defaults to: nil) —
  Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- page_token (::String) (defaults to: nil) —
  A token identifying a page of results the server should return.

Yields:

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

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2363

def list_supported_database_flags request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::ListSupportedDatabaseFlagsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_supported_database_flags.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_supported_database_flags.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_supported_database_flags.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :list_supported_database_flags, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @alloy_db_admin_stub, :list_supported_database_flags, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#restart_instance(request, options = nil) ⇒ `::Gapic::Operation` #restart_instance(name: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Restart an Instance in a cluster. Imperative only.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the restart_instance method.
result = client.restart_instance 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

Overloads:

#restart_instance(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to restart_instance via a request object, either of type RestartInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::RestartInstanceRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#restart_instance(name: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to restart_instance 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:
- name (::String) (defaults to: nil) —
  Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1730

def restart_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::RestartInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.restart_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.restart_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.restart_instance.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :restart_instance, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#restore_cluster(request, options = nil) ⇒ `::Gapic::Operation` #restore_cluster(backup_source: nil, parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the restore_cluster method.
result = client.restore_cluster 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

Overloads:

#restore_cluster(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to restore_cluster via a request object, either of type RestoreClusterRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::RestoreClusterRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#restore_cluster(backup_source: nil, parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to restore_cluster 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:
- backup_source (::Google::Cloud::AlloyDB::V1::BackupSource, ::Hash) (defaults to: nil) —
  Backup source.
- parent (::String) (defaults to: nil) —
  Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
- cluster_id (::String) (defaults to: nil) —
  Required. ID of the requesting object.
- cluster (::Google::Cloud::AlloyDB::V1::Cluster, ::Hash) (defaults to: nil) —
  Required. The resource being created
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 844

def restore_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::RestoreClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.restore_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.restore_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.restore_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :restore_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_backup(request, options = nil) ⇒ `::Gapic::Operation` #update_backup(update_mask: nil, backup: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ `::Gapic::Operation`

Updates the parameters of a single Backup.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the update_backup method.
result = client.update_backup 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

Overloads:

#update_backup(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to update_backup via a request object, either of type UpdateBackupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::UpdateBackupRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_backup(update_mask: nil, backup: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Pass arguments to update_backup 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:
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Optional. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
- backup (::Google::Cloud::AlloyDB::V1::Backup, ::Hash) (defaults to: nil) —
  Required. The resource being updated
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, the backend validates the request, but doesn't actually execute it.
- allow_missing (::Boolean) (defaults to: nil) —
  Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and update_mask is ignored.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2147

def update_backup request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::UpdateBackupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_backup.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.backup&.name
    header_params["backup.name"] = request.backup.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_backup.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_backup.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :update_backup, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_cluster(request, options = nil) ⇒ `::Gapic::Operation` #update_cluster(update_mask: nil, cluster: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ `::Gapic::Operation`

Updates the parameters of a single Cluster.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the update_cluster method.
result = client.update_cluster 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

Overloads:

#update_cluster(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to update_cluster via a request object, either of type UpdateClusterRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::UpdateClusterRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_cluster(update_mask: nil, cluster: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Pass arguments to update_cluster 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:
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
- cluster (::Google::Cloud::AlloyDB::V1::Cluster, ::Hash) (defaults to: nil) —
  Required. The resource being updated
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
- allow_missing (::Boolean) (defaults to: nil) —
  Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and update_mask is ignored.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 607

def update_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::UpdateClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.cluster&.name
    header_params["cluster.name"] = request.cluster.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :update_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_instance(request, options = nil) ⇒ `::Gapic::Operation` #update_instance(update_mask: nil, instance: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ `::Gapic::Operation`

Updates the parameters of a single Instance.

Examples:

Basic example

require "google/cloud/alloy_db/v1"

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

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

# Call the update_instance method.
result = client.update_instance 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

Overloads:

#update_instance(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to update_instance via a request object, either of type UpdateInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AlloyDB::V1::UpdateInstanceRequest, ::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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_instance(update_mask: nil, instance: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Pass arguments to update_instance 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:
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
- instance (::Google::Cloud::AlloyDB::V1::Instance, ::Hash) (defaults to: nil) —
  Required. The resource being updated
- request_id (::String) (defaults to: nil) —
  Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  
  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
  
  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- validate_only (::Boolean) (defaults to: nil) —
  Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
- allow_missing (::Boolean) (defaults to: nil) —
  Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and update_mask is ignored.

Yields:

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

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 1390

def update_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::UpdateInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AlloyDB::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.instance&.name
    header_params["instance.name"] = request.instance.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_instance.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @alloy_db_admin_stub.call_rpc :update_instance, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

Class: Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

Constructor Details

#initialize {|config| ... } ⇒ Client

Examples:

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

#operations_client ⇒ ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Operations (readonly)

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Examples:

Instance Method Details

#batch_create_instances(request, options = nil) ⇒ ::Gapic::Operation #batch_create_instances(parent: nil, requests: nil, request_id: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#configure {|config| ... } ⇒ Client::Configuration

#create_backup(request, options = nil) ⇒ ::Gapic::Operation #create_backup(parent: nil, backup_id: nil, backup: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#create_cluster(request, options = nil) ⇒ ::Gapic::Operation #create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#create_instance(request, options = nil) ⇒ ::Gapic::Operation #create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_backup(request, options = nil) ⇒ ::Gapic::Operation #delete_backup(name: nil, request_id: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_cluster(request, options = nil) ⇒ ::Gapic::Operation #delete_cluster(name: nil, request_id: nil, etag: nil, validate_only: nil, force: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_instance(request, options = nil) ⇒ ::Gapic::Operation #delete_instance(name: nil, request_id: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#failover_instance(request, options = nil) ⇒ ::Gapic::Operation #failover_instance(name: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#get_backup(request, options = nil) ⇒ ::Google::Cloud::AlloyDB::V1::Backup #get_backup(name: nil) ⇒ ::Google::Cloud::AlloyDB::V1::Backup

Examples:

Basic example

#get_cluster(request, options = nil) ⇒ ::Google::Cloud::AlloyDB::V1::Cluster #get_cluster(name: nil) ⇒ ::Google::Cloud::AlloyDB::V1::Cluster

Examples:

Basic example

#get_instance(request, options = nil) ⇒ ::Google::Cloud::AlloyDB::V1::Instance #get_instance(name: nil, view: nil) ⇒ ::Google::Cloud::AlloyDB::V1::Instance

Examples:

Basic example

#list_backups(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup> #list_backups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>

Examples:

Basic example

#list_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster> #list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>

Examples:

Basic example

#list_instances(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance> #list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>

Examples:

Basic example

#list_supported_database_flags(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag> #list_supported_database_flags(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>

Examples:

Basic example

#restart_instance(request, options = nil) ⇒ ::Gapic::Operation #restart_instance(name: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#restore_cluster(request, options = nil) ⇒ ::Gapic::Operation #restore_cluster(backup_source: nil, parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#update_backup(request, options = nil) ⇒ ::Gapic::Operation #update_backup(update_mask: nil, backup: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#update_cluster(request, options = nil) ⇒ ::Gapic::Operation #update_cluster(update_mask: nil, cluster: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#update_instance(request, options = nil) ⇒ ::Gapic::Operation #update_instance(update_mask: nil, instance: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#initialize {|config| ... } ⇒ `Client`

#iam_policy_client ⇒ `Google::Iam::V1::IAMPolicy::Client` (readonly)

#location_client ⇒ `Google::Cloud::Location::Locations::Client` (readonly)

#operations_client ⇒ `::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Operations` (readonly)

.configure {|config| ... } ⇒ `Client::Configuration`

#batch_create_instances(request, options = nil) ⇒ `::Gapic::Operation` #batch_create_instances(parent: nil, requests: nil, request_id: nil) ⇒ `::Gapic::Operation`

#configure {|config| ... } ⇒ `Client::Configuration`

#create_backup(request, options = nil) ⇒ `::Gapic::Operation` #create_backup(parent: nil, backup_id: nil, backup: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#create_cluster(request, options = nil) ⇒ `::Gapic::Operation` #create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#create_instance(request, options = nil) ⇒ `::Gapic::Operation` #create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#delete_backup(request, options = nil) ⇒ `::Gapic::Operation` #delete_backup(name: nil, request_id: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

#delete_cluster(request, options = nil) ⇒ `::Gapic::Operation` #delete_cluster(name: nil, request_id: nil, etag: nil, validate_only: nil, force: nil) ⇒ `::Gapic::Operation`

#delete_instance(request, options = nil) ⇒ `::Gapic::Operation` #delete_instance(name: nil, request_id: nil, etag: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#failover_instance(request, options = nil) ⇒ `::Gapic::Operation` #failover_instance(name: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#get_backup(request, options = nil) ⇒ `::Google::Cloud::AlloyDB::V1::Backup` #get_backup(name: nil) ⇒ `::Google::Cloud::AlloyDB::V1::Backup`

#get_cluster(request, options = nil) ⇒ `::Google::Cloud::AlloyDB::V1::Cluster` #get_cluster(name: nil) ⇒ `::Google::Cloud::AlloyDB::V1::Cluster`

#get_instance(request, options = nil) ⇒ `::Google::Cloud::AlloyDB::V1::Instance` #get_instance(name: nil, view: nil) ⇒ `::Google::Cloud::AlloyDB::V1::Instance`

#list_backups(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>` #list_backups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>`

#list_clusters(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>` #list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>`

#list_instances(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>` #list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>`

#list_supported_database_flags(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>` #list_supported_database_flags(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>`

#restart_instance(request, options = nil) ⇒ `::Gapic::Operation` #restart_instance(name: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#restore_cluster(request, options = nil) ⇒ `::Gapic::Operation` #restore_cluster(backup_source: nil, parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#update_backup(request, options = nil) ⇒ `::Gapic::Operation` #update_backup(update_mask: nil, backup: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ `::Gapic::Operation`

#update_cluster(request, options = nil) ⇒ `::Gapic::Operation` #update_cluster(update_mask: nil, cluster: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ `::Gapic::Operation`

#update_instance(request, options = nil) ⇒ `::Gapic::Operation` #update_instance(update_mask: nil, instance: nil, request_id: nil, validate_only: nil, allow_missing: nil) ⇒ `::Gapic::Operation`