AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client (v0.9.1)

Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.

Client for the AlloyDBAdmin service.

Service describing handlers for resources

Inherits

Object

Includes

Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Paths

Methods

.configure

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

Configure the AlloyDBAdmin Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#batch_create_instances

def batch_create_instances(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the parent resource.
requests (::Google::Cloud::AlloyDB::V1::CreateInstanceRequests, ::Hash) — Required. Resources being created.
request_id (::String) — 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.

Example

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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_backup

def create_backup(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. Value for parent.
backup_id (::String) — Required. ID of the requesting object.
backup (::Google::Cloud::AlloyDB::V1::Backup, ::Hash) — Required. The resource being created
request_id (::String) — 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) — 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.

Example

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

#create_cluster

def create_cluster(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
cluster_id (::String) — Required. ID of the requesting object.
cluster (::Google::Cloud::AlloyDB::V1::Cluster, ::Hash) — Required. The resource being created
request_id (::String) — 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) — 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.

Example

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

#create_instance

def create_instance(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
instance_id (::String) — Required. ID of the requesting object.
instance (::Google::Cloud::AlloyDB::V1::Instance, ::Hash) — Required. The resource being created
request_id (::String) — 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) — 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.

Example

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

#create_secondary_cluster

def create_secondary_cluster(request, options = nil) -> ::Gapic::Operation
def create_secondary_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

Overloads

def create_secondary_cluster(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_secondary_cluster via a request object, either of type CreateSecondaryClusterRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::CreateSecondaryClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_secondary_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to create_secondary_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) — Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
cluster_id (::String) — Required. ID of the requesting object (the secondary cluster).
cluster (::Google::Cloud::AlloyDB::V1::Cluster, ::Hash) — Required. Configuration of the requesting object (the secondary cluster).
request_id (::String) — 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) — 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.

Example

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::CreateSecondaryClusterRequest.new

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

#create_secondary_instance

def create_secondary_instance(request, options = nil) -> ::Gapic::Operation
def create_secondary_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new SECONDARY Instance in a given project and location.

Overloads

def create_secondary_instance(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_secondary_instance via a request object, either of type CreateSecondaryInstanceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::CreateSecondaryInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_secondary_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to create_secondary_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) — Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
instance_id (::String) — Required. ID of the requesting object.
instance (::Google::Cloud::AlloyDB::V1::Instance, ::Hash) — Required. The resource being created
request_id (::String) — 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) — 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.

Example

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::CreateSecondaryInstanceRequest.new

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

#create_user

def create_user(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::User
def create_user(parent: nil, user_id: nil, user: nil, request_id: nil, validate_only: nil) -> ::Google::Cloud::AlloyDB::V1::User

Creates a new User in a given project, location, and cluster.

Overloads

def create_user(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::User

Pass arguments to create_user via a request object, either of type CreateUserRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::CreateUserRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_user(parent: nil, user_id: nil, user: nil, request_id: nil, validate_only: nil) -> ::Google::Cloud::AlloyDB::V1::User

Pass arguments to create_user 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) — Required. Value for parent.
user_id (::String) — Required. ID of the requesting object.
user (::Google::Cloud::AlloyDB::V1::User, ::Hash) — Required. The resource being created
request_id (::String) — 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) — 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 (::Google::Cloud::AlloyDB::V1::User)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AlloyDB::V1::User)

Raises

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

Example

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::CreateUserRequest.new

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

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

#delete_backup

def delete_backup(request, options = nil) -> ::Gapic::Operation
def delete_backup(name: nil, request_id: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation

Deletes a single Backup.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. Name of the resource. For the required format, see the comment on the Backup.name field.
request_id (::String) — 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) — Optional. If set, the backend validates the request, but doesn't actually execute it.
etag (::String) — 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.

Example

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

#delete_cluster

def delete_cluster(request, options = nil) -> ::Gapic::Operation
def delete_cluster(name: nil, request_id: nil, etag: nil, validate_only: nil, force: nil) -> ::Gapic::Operation

Deletes a single Cluster.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
request_id (::String) — 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) — 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) — 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) — 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.

Example

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

#delete_instance

def delete_instance(request, options = nil) -> ::Gapic::Operation
def delete_instance(name: nil, request_id: nil, etag: nil, validate_only: nil) -> ::Gapic::Operation

Deletes a single Instance.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.
request_id (::String) — 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) — 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) — 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.

Example

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

#delete_user

def delete_user(request, options = nil) -> ::Google::Protobuf::Empty
def delete_user(name: nil, request_id: nil, validate_only: nil) -> ::Google::Protobuf::Empty

Deletes a single User.

Overloads

def delete_user(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_user via a request object, either of type DeleteUserRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::DeleteUserRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_user(name: nil, request_id: nil, validate_only: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_user 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) — Required. The name of the resource. For the required format, see the comment on the User.name field.
request_id (::String) — 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) — 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 (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::DeleteUserRequest.new

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

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

#failover_instance

def failover_instance(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.
request_id (::String) — 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) — 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.

Example

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

#generate_client_certificate

def generate_client_certificate(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse
def generate_client_certificate(parent: nil, request_id: nil, cert_duration: nil, public_key: nil, use_metadata_exchange: nil) -> ::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse

Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

Overloads

def generate_client_certificate(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse

Pass arguments to generate_client_certificate via a request object, either of type GenerateClientCertificateRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::GenerateClientCertificateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def generate_client_certificate(parent: nil, request_id: nil, cert_duration: nil, public_key: nil, use_metadata_exchange: nil) -> ::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse

Pass arguments to generate_client_certificate 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) —
Required. The name of the parent resource. The required format is:
- projects/{project}/locations/{location}/clusters/{cluster}
request_id (::String) — 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).
cert_duration (::Google::Protobuf::Duration, ::Hash) — Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.
public_key (::String) — Optional. The public key from the client.
use_metadata_exchange (::Boolean) — Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse)

Raises

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

Example

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::GenerateClientCertificateRequest.new

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

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

#get_backup

def get_backup(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::Backup
def get_backup(name: nil) -> ::Google::Cloud::AlloyDB::V1::Backup

Gets details of a single Backup.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — 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.

Example

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

#get_cluster

def get_cluster(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::Cluster
def get_cluster(name: nil, view: nil) -> ::Google::Cloud::AlloyDB::V1::Cluster

Gets details of a single Cluster.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_cluster(name: nil, view: 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) — Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
view (::Google::Cloud::AlloyDB::V1::ClusterView) — Optional. The view of the cluster to return. Returns all default fields if not set.

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.

Example

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

#get_connection_info

def get_connection_info(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::ConnectionInfo
def get_connection_info(parent: nil, request_id: nil) -> ::Google::Cloud::AlloyDB::V1::ConnectionInfo

Get instance metadata used for a connection.

Overloads

def get_connection_info(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::ConnectionInfo

Pass arguments to get_connection_info via a request object, either of type GetConnectionInfoRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::GetConnectionInfoRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_connection_info(parent: nil, request_id: nil) -> ::Google::Cloud::AlloyDB::V1::ConnectionInfo

Pass arguments to get_connection_info 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) — Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
request_id (::String) — 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).

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::AlloyDB::V1::ConnectionInfo)

Raises

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

Example

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::GetConnectionInfoRequest.new

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

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

#get_instance

def get_instance(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::Instance
def get_instance(name: nil, view: nil) -> ::Google::Cloud::AlloyDB::V1::Instance

Gets details of a single Instance.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.
view (::Google::Cloud::AlloyDB::V1::InstanceView) — 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.

Example

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

#get_user

def get_user(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::User
def get_user(name: nil) -> ::Google::Cloud::AlloyDB::V1::User

Gets details of a single User.

Overloads

def get_user(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::User

Pass arguments to get_user via a request object, either of type GetUserRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::GetUserRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_user(name: nil) -> ::Google::Cloud::AlloyDB::V1::User

Pass arguments to get_user 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).

Parameter

name (::String) — Required. The name of the resource. For the required format, see the comment on the User.name field.

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::AlloyDB::V1::User)

Raises

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

Example

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::GetUserRequest.new

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

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

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

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

Returns

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

#initialize

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

Create a new AlloyDBAdmin client object.

Yields

(config) — Configure the AlloyDBAdmin client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# 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

#inject_fault

def inject_fault(request, options = nil) -> ::Gapic::Operation
def inject_fault(fault_type: nil, name: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Injects fault in an instance. Imperative only.

Overloads

def inject_fault(request, options = nil) -> ::Gapic::Operation

Pass arguments to inject_fault via a request object, either of type InjectFaultRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::InjectFaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def inject_fault(fault_type: nil, name: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to inject_fault 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

fault_type (::Google::Cloud::AlloyDB::V1::InjectFaultRequest::FaultType) — Required. The type of fault to be injected in an instance.
name (::String) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.
request_id (::String) — 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) — Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.

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.

Example

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::InjectFaultRequest.new

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

#list_backups

def list_backups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Backup>
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

Example

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

#list_clusters

def list_clusters(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Cluster>
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — A token identifying a page of results the server should return.
filter (::String) — Optional. Filtering results
order_by (::String) — 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.

Example

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

#list_instances

def list_instances(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::Instance>
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — A token identifying a page of results the server should return.
filter (::String) — Optional. Filtering results
order_by (::String) — 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.

Example

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

#list_supported_database_flags

def list_supported_database_flags(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — 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.

Example

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

#list_users

def list_users(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::User>
def list_users(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::User>

Lists Users in a given project and location.

Overloads

def list_users(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::User>

Pass arguments to list_users via a request object, either of type ListUsersRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::ListUsersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_users(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1::User>

Pass arguments to list_users 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) — Required. Parent value for ListUsersRequest
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — Optional. A token identifying a page of results the server should return.
filter (::String) — Optional. Filtering results
order_by (::String) — 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::User>)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::ListUsersRequest.new

# Call the list_users method.
result = client.list_users 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::User.
  p item
end

#location_client

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

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

Returns

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

#operations_client

def operations_client() -> ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Operations

Get the associated client for long-running operations.

Returns

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

#promote_cluster

def promote_cluster(request, options = nil) -> ::Gapic::Operation
def promote_cluster(name: nil, request_id: nil, etag: nil, validate_only: nil) -> ::Gapic::Operation

Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

Overloads

def promote_cluster(request, options = nil) -> ::Gapic::Operation

Pass arguments to promote_cluster via a request object, either of type PromoteClusterRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::PromoteClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def promote_cluster(name: nil, request_id: nil, etag: nil, validate_only: nil) -> ::Gapic::Operation

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

Example

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::PromoteClusterRequest.new

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

#restart_instance

def restart_instance(request, options = nil) -> ::Gapic::Operation
def restart_instance(name: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Restart an Instance in a cluster. Imperative only.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.
request_id (::String) — 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) — 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.

Example

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

#restore_cluster

def restore_cluster(request, options = nil) -> ::Gapic::Operation
def restore_cluster(backup_source: nil, continuous_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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def restore_cluster(backup_source: nil, continuous_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) — Backup source.
continuous_backup_source (::Google::Cloud::AlloyDB::V1::ContinuousBackupSource, ::Hash) — ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.
parent (::String) — Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
cluster_id (::String) — Required. ID of the requesting object.
cluster (::Google::Cloud::AlloyDB::V1::Cluster, ::Hash) — Required. The resource being created
request_id (::String) — 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) — 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.

Example

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_backup

def update_backup(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — Required. The resource being updated
request_id (::String) — 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) — Optional. If set, the backend validates the request, but doesn't actually execute it.
allow_missing (::Boolean) — 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.

Example

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

#update_cluster

def update_cluster(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — Required. The resource being updated
request_id (::String) — 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) — 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) — 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.

Example

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

#update_instance

def update_instance(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — Required. The resource being updated
request_id (::String) — 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) — 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) — 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.

Example

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

#update_user

def update_user(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::User
def update_user(update_mask: nil, user: nil, request_id: nil, validate_only: nil, allow_missing: nil) -> ::Google::Cloud::AlloyDB::V1::User

Updates the parameters of a single User.

Overloads

def update_user(request, options = nil) -> ::Google::Cloud::AlloyDB::V1::User

Pass arguments to update_user via a request object, either of type UpdateUserRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AlloyDB::V1::UpdateUserRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_user(update_mask: nil, user: nil, request_id: nil, validate_only: nil, allow_missing: nil) -> ::Google::Cloud::AlloyDB::V1::User

Pass arguments to update_user 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) — Optional. Field mask is used to specify the fields to be overwritten in the User 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.
user (::Google::Cloud::AlloyDB::V1::User, ::Hash) — Required. The resource being updated
request_id (::String) — 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) — Optional. If set, the backend validates the request, but doesn't actually execute it.
allow_missing (::Boolean) — Optional. Allow missing fields in the update mask.

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::AlloyDB::V1::User)

Raises

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

Example

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::UpdateUserRequest.new

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

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