Backup and DR Service V1BETA API - Class Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client (v0.1.0)

Reference documentation and code samples for the Backup and DR Service V1BETA API class Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.

REST client for the BackupDR service.

The BackupDR Service

Inherits

  • Object

Includes

Methods

.configure

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

Configure the BackupDR Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all BackupDR clients
::Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the BackupDR Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_auto_protection_policy

def create_auto_protection_policy(request, options = nil) -> ::Gapic::Operation
def create_auto_protection_policy(parent: nil, auto_protection_policy_id: nil, auto_protection_policy: nil) -> ::Gapic::Operation

Creates a new AutoProtectionPolicy in a given project and location.

Overloads 
def create_auto_protection_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_auto_protection_policy via a request object, either of type CreateAutoProtectionPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::CreateAutoProtectionPolicyRequest, ::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_auto_protection_policy(parent: nil, auto_protection_policy_id: nil, auto_protection_policy: nil) -> ::Gapic::Operation
Pass arguments to create_auto_protection_policy 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 parent resource where this policy will be created. Format: projects/{project}/locations/{location}
  • auto_protection_policy_id (::String) — Required. The ID to use for the policy. This will become the final component of the policy's resource name.
  • auto_protection_policy (::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy, ::Hash) — Required. The AutoProtectionPolicy resource to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::CreateAutoProtectionPolicyRequest.new

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

def create_auto_protection_policy_binding(request, options = nil) -> ::Gapic::Operation
def create_auto_protection_policy_binding(parent: nil, auto_protection_policy_binding_id: nil, auto_protection_policy_binding: nil) -> ::Gapic::Operation

Creates a new AutoProtectionPolicyBinding in a given project and location.

Overloads 
def create_auto_protection_policy_binding(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_auto_protection_policy_binding via a request object, either of type CreateAutoProtectionPolicyBindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::CreateAutoProtectionPolicyBindingRequest, ::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_auto_protection_policy_binding(parent: nil, auto_protection_policy_binding_id: nil, auto_protection_policy_binding: nil) -> ::Gapic::Operation
Pass arguments to create_auto_protection_policy_binding 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 parent resource where this binding will be created. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
  • auto_protection_policy_binding_id (::String) — Required. The ID to use for the binding. This will become the final component of the binding's resource name.
  • auto_protection_policy_binding (::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding, ::Hash) — Required. The AutoProtectionPolicyBinding resource to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::CreateAutoProtectionPolicyBindingRequest.new

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

def create_backup_plan(request, options = nil) -> ::Gapic::Operation
def create_backup_plan(parent: nil, backup_plan_id: nil, backup_plan: nil, request_id: nil) -> ::Gapic::Operation

Create a BackupPlan

Overloads 
def create_backup_plan(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_backup_plan via a request object, either of type CreateBackupPlanRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::CreateBackupPlanRequest, ::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_plan(parent: nil, backup_plan_id: nil, backup_plan: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_backup_plan 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 BackupPlan project and location in the format projects/{project}/locations/{location}. In Google Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.
  • backup_plan_id (::String) — Required. The name of the BackupPlan to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /[a-z][a-z0-9-]{,62}/.
  • backup_plan (::Google::Cloud::BackupDR::V1beta::BackupPlan, ::Hash) — Required. The BackupPlan resource object to create.
  • 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 t he 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::CreateBackupPlanRequest.new

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

def create_backup_plan_association(request, options = nil) -> ::Gapic::Operation
def create_backup_plan_association(parent: nil, backup_plan_association_id: nil, backup_plan_association: nil, request_id: nil) -> ::Gapic::Operation

Create a BackupPlanAssociation

Overloads 
def create_backup_plan_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_backup_plan_association via a request object, either of type CreateBackupPlanAssociationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::CreateBackupPlanAssociationRequest, ::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_plan_association(parent: nil, backup_plan_association_id: nil, backup_plan_association: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_backup_plan_association 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 backup plan association project and location in the format projects/{project_id}/locations/{location}. In Backup and DR locations map to Google Cloud regions, for example us-central1.
  • backup_plan_association_id (::String) — Required. The name of the backup plan association to create. The name must be unique for the specified project and location.
  • backup_plan_association (::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation, ::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 t he 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::CreateBackupPlanAssociationRequest.new

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

def create_backup_vault(request, options = nil) -> ::Gapic::Operation
def create_backup_vault(parent: nil, backup_vault_id: nil, backup_vault: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new BackupVault in a given project and location.

Overloads 
def create_backup_vault(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_backup_vault via a request object, either of type CreateBackupVaultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::CreateBackupVaultRequest, ::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_vault(parent: nil, backup_vault_id: nil, backup_vault: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_backup_vault 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_vault_id (::String) — Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC
  • backup_vault (::Google::Cloud::BackupDR::V1beta::BackupVault, ::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. Only validate the request, but do not perform mutations. The default is 'false'.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::CreateBackupVaultRequest.new

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

def create_management_server(request, options = nil) -> ::Gapic::Operation
def create_management_server(parent: nil, management_server_id: nil, management_server: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ManagementServer in a given project and location.

Overloads 
def create_management_server(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_management_server via a request object, either of type CreateManagementServerRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::CreateManagementServerRequest, ::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_management_server(parent: nil, management_server_id: nil, management_server: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_management_server 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 management server project and location in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.
  • management_server_id (::String) — Required. The name of the management server to create. The name must be unique for the specified project and location.
  • management_server (::Google::Cloud::BackupDR::V1beta::ManagementServer, ::Hash) — Required. A [management server resource][google.cloud.backupdr.v1.ManagementServer]
  • 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::CreateManagementServerRequest.new

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

def delete_auto_protection_policy(request, options = nil) -> ::Gapic::Operation
def delete_auto_protection_policy(name: nil, etag: nil) -> ::Gapic::Operation

Deletes a single AutoProtectionPolicy.

Overloads 
def delete_auto_protection_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_auto_protection_policy via a request object, either of type DeleteAutoProtectionPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::DeleteAutoProtectionPolicyRequest, ::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_auto_protection_policy(name: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_auto_protection_policy 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 policy to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
  • etag (::String) — The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::DeleteAutoProtectionPolicyRequest.new

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

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

Deletes a 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::BackupDR::V1beta::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) -> ::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.
  • 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::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_backup_plan

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

Deletes a single BackupPlan.

Overloads 
def delete_backup_plan(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_backup_plan via a request object, either of type DeleteBackupPlanRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::DeleteBackupPlanRequest, ::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_plan(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_backup_plan 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 resource name of the BackupPlan to delete.

    Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

  • 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::DeleteBackupPlanRequest.new

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

def delete_backup_plan_association(request, options = nil) -> ::Gapic::Operation
def delete_backup_plan_association(name: nil, request_id: nil, auto_protection_policy_binding: nil) -> ::Gapic::Operation

Deletes a single BackupPlanAssociation.

Overloads 
def delete_backup_plan_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_backup_plan_association via a request object, either of type DeleteBackupPlanAssociationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::DeleteBackupPlanAssociationRequest, ::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_plan_association(name: nil, request_id: nil, auto_protection_policy_binding: nil) -> ::Gapic::Operation
Pass arguments to delete_backup_plan_association 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 backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
  • 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).

  • auto_protection_policy_binding (::String) — Optional. This field is exclusively used by Backup and DR's auto-protection feature. The resource name of the AutoProtectionPolicyBinding that triggered the deletion of this association. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::DeleteBackupPlanAssociationRequest.new

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

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

Deletes a BackupVault.

Overloads 
def delete_backup_vault(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_backup_vault via a request object, either of type DeleteBackupVaultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::DeleteBackupVaultRequest, ::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_vault(name: nil, request_id: nil, force: nil, etag: nil, validate_only: nil, allow_missing: nil, ignore_backup_plan_references: nil) -> ::Gapic::Operation
Pass arguments to delete_backup_vault 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.
  • 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).

  • force (::Boolean) — Optional. If set to true, any data source from this backup vault will also be deleted.
  • etag (::String) — The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.
  • validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is 'false'.
  • allow_missing (::Boolean) — Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.
  • ignore_backup_plan_references (::Boolean) — Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::DeleteBackupVaultRequest.new

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

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

Deletes a single ManagementServer.

Overloads 
def delete_management_server(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_management_server via a request object, either of type DeleteManagementServerRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::DeleteManagementServerRequest, ::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_management_server(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_management_server 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
  • 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::DeleteManagementServerRequest.new

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

#fetch_backup_plan_associations_for_resource_type

def fetch_backup_plan_associations_for_resource_type(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>
def fetch_backup_plan_associations_for_resource_type(parent: nil, resource_type: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>

List BackupPlanAssociations for a given resource type.

Overloads 
def fetch_backup_plan_associations_for_resource_type(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>
Pass arguments to fetch_backup_plan_associations_for_resource_type via a request object, either of type FetchBackupPlanAssociationsForResourceTypeRequest or an equivalent Hash.
Parameters 
def fetch_backup_plan_associations_for_resource_type(parent: nil, resource_type: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>
Pass arguments to fetch_backup_plan_associations_for_resource_type 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 parent resource name. Format: projects/{project}/locations/{location}
  • resource_type (::String) — Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance
  • page_size (::Integer) — Optional. The maximum number of BackupPlanAssociations to return. The service may return fewer than this value. If unspecified, at most 50 BackupPlanAssociations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  • page_token (::String) — Optional. A page token, received from a previous call of FetchBackupPlanAssociationsForResourceType. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to FetchBackupPlanAssociationsForResourceType must match the call that provided the page token.

  • filter (::String) —

    Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:

    • resource
    • backup_plan
    • state
    • data_source
    • cloud_sql_instance_backup_plan_association_properties.instance_create_time
  • order_by (::String) —

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

    Supported fields:

    • name
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::FetchBackupPlanAssociationsForResourceTypeRequest.new

# Call the fetch_backup_plan_associations_for_resource_type method.
result = client.fetch_backup_plan_associations_for_resource_type 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::BackupDR::V1beta::BackupPlanAssociation.
  p item
end

#fetch_backups_for_resource_type

def fetch_backups_for_resource_type(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::Backup>
def fetch_backups_for_resource_type(parent: nil, resource_type: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::Backup>

Fetch Backups for a given resource type.

Overloads 
def fetch_backups_for_resource_type(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::Backup>
Pass arguments to fetch_backups_for_resource_type via a request object, either of type FetchBackupsForResourceTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::FetchBackupsForResourceTypeRequest, ::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 fetch_backups_for_resource_type(parent: nil, resource_type: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::Backup>
Pass arguments to fetch_backups_for_resource_type 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. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}
  • resource_type (::String) — Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance
  • page_size (::Integer) — Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  • page_token (::String) — Optional. A page token, received from a previous call of FetchBackupsForResourceType. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to FetchBackupsForResourceType must match the call that provided the page token.

  • filter (::String) —

    Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:

    • name
    • state
    • backup_type
    • create_time
    • expire_time
    • enforced_retention_end_time
    • gcp_backup_plan_info.backup_plan
    • cloud_sql_instance_backup_properties.instance_tier
    • cloud_sql_instance_backup_properties.database_installed_version
  • order_by (::String) —

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

    Supported fields:

    • name
  • view (::Google::Cloud::BackupDR::V1beta::BackupView) — Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::FetchBackupsForResourceTypeRequest.new

# Call the fetch_backups_for_resource_type method.
result = client.fetch_backups_for_resource_type 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::BackupDR::V1beta::Backup.
  p item
end

#fetch_data_source_references_for_resource_type

def fetch_data_source_references_for_resource_type(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>
def fetch_data_source_references_for_resource_type(parent: nil, resource_type: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>

Fetch DataSourceReferences for a given project, location and resource type.

Overloads 
def fetch_data_source_references_for_resource_type(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>
Pass arguments to fetch_data_source_references_for_resource_type via a request object, either of type FetchDataSourceReferencesForResourceTypeRequest or an equivalent Hash.
Parameters 
def fetch_data_source_references_for_resource_type(parent: nil, resource_type: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>
Pass arguments to fetch_data_source_references_for_resource_type 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 parent resource name. Format: projects/{project}/locations/{location}
  • resource_type (::String) — Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance
  • page_size (::Integer) — Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  • page_token (::String) — Optional. A page token, received from a previous call of FetchDataSourceReferencesForResourceType. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to FetchDataSourceReferencesForResourceType must match the call that provided the page token.

  • filter (::String) —

    Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:

    • data_source
    • data_source_gcp_resource_info.gcp_resourcename
    • data_source_backup_config_state
    • data_source_backup_count
    • data_source_backup_config_info.last_backup_state
    • data_source_gcp_resource_info.gcp_resourcename
    • data_source_gcp_resource_info.type
    • data_source_gcp_resource_info.location
    • data_source_gcp_resource_info.cloud_sql_instance_properties.instance_create_time
  • order_by (::String) —

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

    Supported fields:

    • name
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::FetchDataSourceReferencesForResourceTypeRequest.new

# Call the fetch_data_source_references_for_resource_type method.
result = client.fetch_data_source_references_for_resource_type 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::BackupDR::V1beta::DataSourceReference.
  p item
end

#fetch_usable_backup_vaults

def fetch_usable_backup_vaults(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>
def fetch_usable_backup_vaults(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>

FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.

Overloads 
def fetch_usable_backup_vaults(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>
Pass arguments to fetch_usable_backup_vaults via a request object, either of type FetchUsableBackupVaultsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::FetchUsableBackupVaultsRequest, ::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 fetch_usable_backup_vaults(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>
Pass arguments to fetch_usable_backup_vaults 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 project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
  • 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::FetchUsableBackupVaultsRequest.new

# Call the fetch_usable_backup_vaults method.
result = client.fetch_usable_backup_vaults 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::BackupDR::V1beta::BackupVault.
  p item
end

#get_auto_protection_policy

def get_auto_protection_policy(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy
def get_auto_protection_policy(name: nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy

Gets details of a single AutoProtectionPolicy.

Overloads 
def get_auto_protection_policy(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy
Pass arguments to get_auto_protection_policy via a request object, either of type GetAutoProtectionPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetAutoProtectionPolicyRequest, ::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_auto_protection_policy(name: nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy
Pass arguments to get_auto_protection_policy 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 policy to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetAutoProtectionPolicyRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy.
p result

#get_auto_protection_policy_binding

def get_auto_protection_policy_binding(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding
def get_auto_protection_policy_binding(name: nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding

Returns the auto protection policy binding read from the CCFE tables.

Overloads 
def get_auto_protection_policy_binding(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding
Pass arguments to get_auto_protection_policy_binding via a request object, either of type GetAutoProtectionPolicyBindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetAutoProtectionPolicyBindingRequest, ::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_auto_protection_policy_binding(name: nil) -> ::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding
Pass arguments to get_auto_protection_policy_binding 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 binding to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetAutoProtectionPolicyBindingRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding.
p result

#get_backup

def get_backup(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::Backup
def get_backup(name: nil, view: nil) -> ::Google::Cloud::BackupDR::V1beta::Backup

Gets details of a Backup.

Overloads 
def get_backup(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::Backup
Pass arguments to get_backup via a request object, either of type GetBackupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::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, view: nil) -> ::Google::Cloud::BackupDR::V1beta::Backup
Pass arguments to get_backup via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'
  • view (::Google::Cloud::BackupDR::V1beta::BackupView) — Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

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

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::Backup.
p result

#get_backup_plan

def get_backup_plan(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlan
def get_backup_plan(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlan

Gets details of a single BackupPlan.

Overloads 
def get_backup_plan(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlan
Pass arguments to get_backup_plan via a request object, either of type GetBackupPlanRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetBackupPlanRequest, ::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_plan(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlan
Pass arguments to get_backup_plan 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 resource name of the BackupPlan to retrieve.

    Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetBackupPlanRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::BackupPlan.
p result

#get_backup_plan_association

def get_backup_plan_association(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation
def get_backup_plan_association(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation

Gets details of a single BackupPlanAssociation.

Overloads 
def get_backup_plan_association(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation
Pass arguments to get_backup_plan_association via a request object, either of type GetBackupPlanAssociationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetBackupPlanAssociationRequest, ::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_plan_association(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation
Pass arguments to get_backup_plan_association 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 backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetBackupPlanAssociationRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::BackupPlanAssociation.
p result

#get_backup_plan_revision

def get_backup_plan_revision(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanRevision
def get_backup_plan_revision(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanRevision

Gets details of a single BackupPlanRevision.

Overloads 
def get_backup_plan_revision(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanRevision
Pass arguments to get_backup_plan_revision via a request object, either of type GetBackupPlanRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetBackupPlanRevisionRequest, ::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_plan_revision(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupPlanRevision
Pass arguments to get_backup_plan_revision 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 resource name of the BackupPlanRevision to retrieve.

    Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetBackupPlanRevisionRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::BackupPlanRevision.
p result

#get_backup_vault

def get_backup_vault(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupVault
def get_backup_vault(name: nil, view: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupVault

Gets details of a BackupVault.

Overloads 
def get_backup_vault(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BackupVault
Pass arguments to get_backup_vault via a request object, either of type GetBackupVaultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetBackupVaultRequest, ::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_vault(name: nil, view: nil) -> ::Google::Cloud::BackupDR::V1beta::BackupVault
Pass arguments to get_backup_vault 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 backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'
  • view (::Google::Cloud::BackupDR::V1beta::BackupVaultView) — Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetBackupVaultRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::BackupVault.
p result

#get_binding_matching_resource

def get_binding_matching_resource(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BindingMatchingResource
def get_binding_matching_resource(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BindingMatchingResource

Gets details of a single Binding Matching Resource.

Overloads 
def get_binding_matching_resource(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::BindingMatchingResource
Pass arguments to get_binding_matching_resource via a request object, either of type GetBindingMatchingResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetBindingMatchingResourceRequest, ::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_binding_matching_resource(name: nil) -> ::Google::Cloud::BackupDR::V1beta::BindingMatchingResource
Pass arguments to get_binding_matching_resource 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 matching resource to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetBindingMatchingResourceRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::BindingMatchingResource.
p result

#get_data_source

def get_data_source(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::DataSource
def get_data_source(name: nil) -> ::Google::Cloud::BackupDR::V1beta::DataSource

Gets details of a DataSource.

Overloads 
def get_data_source(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::DataSource
Pass arguments to get_data_source via a request object, either of type GetDataSourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetDataSourceRequest, ::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_data_source(name: nil) -> ::Google::Cloud::BackupDR::V1beta::DataSource
Pass arguments to get_data_source 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 data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetDataSourceRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::DataSource.
p result

#get_data_source_reference

def get_data_source_reference(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::DataSourceReference
def get_data_source_reference(name: nil) -> ::Google::Cloud::BackupDR::V1beta::DataSourceReference

Gets details of a single DataSourceReference.

Overloads 
def get_data_source_reference(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::DataSourceReference
Pass arguments to get_data_source_reference via a request object, either of type GetDataSourceReferenceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetDataSourceReferenceRequest, ::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_data_source_reference(name: nil) -> ::Google::Cloud::BackupDR::V1beta::DataSourceReference
Pass arguments to get_data_source_reference 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 DataSourceReference to retrieve. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetDataSourceReferenceRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::DataSourceReference.
p result

#get_management_server

def get_management_server(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::ManagementServer
def get_management_server(name: nil) -> ::Google::Cloud::BackupDR::V1beta::ManagementServer

Gets details of a single ManagementServer.

Overloads 
def get_management_server(request, options = nil) -> ::Google::Cloud::BackupDR::V1beta::ManagementServer
Pass arguments to get_management_server via a request object, either of type GetManagementServerRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::GetManagementServerRequest, ::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_management_server(name: nil) -> ::Google::Cloud::BackupDR::V1beta::ManagementServer
Pass arguments to get_management_server 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 management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{resource_name}'
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::GetManagementServerRequest.new

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

# The returned object is of type Google::Cloud::BackupDR::V1beta::ManagementServer.
p result

#iam_policy_client

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

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

Returns
  • (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

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

Create a new BackupDR REST client object.

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

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

#initialize_service

def initialize_service(request, options = nil) -> ::Gapic::Operation
def initialize_service(cloud_sql_instance_initialization_config: nil, name: nil, resource_type: nil, request_id: nil, backup_plan_location: nil, validate_only: nil) -> ::Gapic::Operation

Initializes the service related config for a project.

Overloads 
def initialize_service(request, options = nil) -> ::Gapic::Operation
Pass arguments to initialize_service via a request object, either of type InitializeServiceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::InitializeServiceRequest, ::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 initialize_service(cloud_sql_instance_initialization_config: nil, name: nil, resource_type: nil, request_id: nil, backup_plan_location: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to initialize_service 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
  • cloud_sql_instance_initialization_config (::Google::Cloud::BackupDR::V1beta::CloudSqlInstanceInitializationConfig, ::Hash) — Optional. The configuration for initializing a Cloud SQL instance.
  • name (::String) — Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault. Format: projects/{project_id}/locations/{location}/serviceConfig.
  • resource_type (::String) — Required. The resource type to which the default service config will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
  • 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 t he 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).

  • backup_plan_location (::String) — Optional. The location where the BackupPlan will be created. This field is required for multi-region BackupVaults and is optional for regional BackupVaults. It is useful when creating a Backup Vault in a multi-region, allowing the BackupPlan to reside in a specific region within that multi-region. If this field is not provided, the BackupPlan will be created in the same location as specified in the name field.
  • validate_only (::Boolean) — Optional. If set, validates the request and returns the result, but does not actually run it.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::InitializeServiceRequest.new

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

#initiate_delete_auto_protection_policy_binding

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

InitiateDeleteAutoProtectionPolicyBinding initiates delete for AutoProtectionPolicy Binding

Overloads 
def initiate_delete_auto_protection_policy_binding(request, options = nil) -> ::Gapic::Operation
Pass arguments to initiate_delete_auto_protection_policy_binding via a request object, either of type InitiateDeleteAutoProtectionPolicyBindingRequest or an equivalent Hash.
Parameters 
def initiate_delete_auto_protection_policy_binding(name: nil) -> ::Gapic::Operation
Pass arguments to initiate_delete_auto_protection_policy_binding 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 binding to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::InitiateDeleteAutoProtectionPolicyBindingRequest.new

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

def list_applied_auto_protection_policies(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AppliedAutoProtectionPolicy>
def list_applied_auto_protection_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AppliedAutoProtectionPolicy>

Lists AppliedAutoProtectionPolicies in a given project and location.

Overloads 
def list_applied_auto_protection_policies(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AppliedAutoProtectionPolicy>
Pass arguments to list_applied_auto_protection_policies via a request object, either of type ListAppliedAutoProtectionPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListAppliedAutoProtectionPoliciesRequest, ::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_applied_auto_protection_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AppliedAutoProtectionPolicy>
Pass arguments to list_applied_auto_protection_policies 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 project and location for which to retrieve the list of applied policies. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The maximum number of applied policies to return in a single page.
  • page_token (::String) — Optional. A page token, received from a previous ListAppliedAutoProtectionPolicies call.
  • filter (::String) — Optional. A filter expression that filters resources listed in the response.
  • order_by (::String) — Optional. An expression that sorts the results in the response.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListAppliedAutoProtectionPoliciesRequest.new

# Call the list_applied_auto_protection_policies method.
result = client.list_applied_auto_protection_policies 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::BackupDR::V1beta::AppliedAutoProtectionPolicy.
  p item
end

#list_auto_protection_policies

def list_auto_protection_policies(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy>
def list_auto_protection_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy>

Lists AutoProtectionPolicies for a given project and location.

Overloads 
def list_auto_protection_policies(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy>
Pass arguments to list_auto_protection_policies via a request object, either of type ListAutoProtectionPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListAutoProtectionPoliciesRequest, ::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_auto_protection_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy>
Pass arguments to list_auto_protection_policies 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 project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.
  • page_token (::String) — Optional. A page token, received from a previous ListAutoProtectionPolicies call. Provide this to retrieve the subsequent page.
  • filter (::String) — Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
  • order_by (::String) — Optional. An expression that sorts the results in the response. The following fields are sortable:
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListAutoProtectionPoliciesRequest.new

# Call the list_auto_protection_policies method.
result = client.list_auto_protection_policies 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::BackupDR::V1beta::AutoProtectionPolicy.
  p item
end

#list_auto_protection_policy_bindings

def list_auto_protection_policy_bindings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding>
def list_auto_protection_policy_bindings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding>

Returns the auto protection policy bindings read from the CCFE tables.

Overloads 
def list_auto_protection_policy_bindings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding>
Pass arguments to list_auto_protection_policy_bindings via a request object, either of type ListAutoProtectionPolicyBindingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListAutoProtectionPolicyBindingsRequest, ::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_auto_protection_policy_bindings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicyBinding>
Pass arguments to list_auto_protection_policy_bindings 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 project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.
  • page_token (::String) — Optional. A page token, received from a previous ListAutoProtectionPolicies call. Provide this to retrieve the subsequent page.
  • filter (::String) — Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
  • order_by (::String) — Optional. An expression that sorts the results in the response. The following fields are sortable:
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListAutoProtectionPolicyBindingsRequest.new

# Call the list_auto_protection_policy_bindings method.
result = client.list_auto_protection_policy_bindings 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::BackupDR::V1beta::AutoProtectionPolicyBinding.
  p item
end

#list_backup_plan_associations

def list_backup_plan_associations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>
def list_backup_plan_associations(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>

Lists BackupPlanAssociations in a given project and location.

Overloads 
def list_backup_plan_associations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>
Pass arguments to list_backup_plan_associations via a request object, either of type ListBackupPlanAssociationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListBackupPlanAssociationsRequest, ::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_backup_plan_associations(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation>
Pass arguments to list_backup_plan_associations 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 project and location for which to retrieve backup Plan Associations information, in the format projects/{project_id}/locations/{location}. In Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backup plan associations for all locations, use "-" for the {location} value.
  • 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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListBackupPlanAssociationsRequest.new

# Call the list_backup_plan_associations method.
result = client.list_backup_plan_associations 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::BackupDR::V1beta::BackupPlanAssociation.
  p item
end

#list_backup_plan_revisions

def list_backup_plan_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanRevision>
def list_backup_plan_revisions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanRevision>

Lists BackupPlanRevisions in a given project and location.

Overloads 
def list_backup_plan_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanRevision>
Pass arguments to list_backup_plan_revisions via a request object, either of type ListBackupPlanRevisionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListBackupPlanRevisionsRequest, ::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_backup_plan_revisions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlanRevision>
Pass arguments to list_backup_plan_revisions 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 project and location for which to retrieve BackupPlanRevisions information. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. us-central1.
  • page_size (::Integer) — Optional. The maximum number of BackupPlans to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • page_token (::String) — Optional. The value of next_page_token received from a previous ListBackupPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackupPlans must match the call that provided the page token.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListBackupPlanRevisionsRequest.new

# Call the list_backup_plan_revisions method.
result = client.list_backup_plan_revisions 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::BackupDR::V1beta::BackupPlanRevision.
  p item
end

#list_backup_plans

def list_backup_plans(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlan>
def list_backup_plans(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlan>

Lists BackupPlans in a given project and location.

Overloads 
def list_backup_plans(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlan>
Pass arguments to list_backup_plans via a request object, either of type ListBackupPlansRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListBackupPlansRequest, ::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_backup_plans(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupPlan>
Pass arguments to list_backup_plans 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 project and location for which to retrieve BackupPlans information. Format: projects/{project}/locations/{location}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. us-central1. To retrieve backup plans for all locations, use "-" for the {location} value.
  • page_size (::Integer) — Optional. The maximum number of BackupPlans to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • page_token (::String) — Optional. The value of next_page_token received from a previous ListBackupPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackupPlans must match the call that provided the page token.
  • filter (::String) — Optional. Field match expression used to filter the results.
  • order_by (::String) — Optional. Field by which to sort the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListBackupPlansRequest.new

# Call the list_backup_plans method.
result = client.list_backup_plans 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::BackupDR::V1beta::BackupPlan.
  p item
end

#list_backup_vaults

def list_backup_vaults(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>
def list_backup_vaults(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>

Lists BackupVaults in a given project and location.

Overloads 
def list_backup_vaults(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>
Pass arguments to list_backup_vaults via a request object, either of type ListBackupVaultsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListBackupVaultsRequest, ::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_backup_vaults(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BackupVault>
Pass arguments to list_backup_vaults 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 project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
  • 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.
  • view (::Google::Cloud::BackupDR::V1beta::BackupVaultView) — Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListBackupVaultsRequest.new

# Call the list_backup_vaults method.
result = client.list_backup_vaults 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::BackupDR::V1beta::BackupVault.
  p item
end

#list_backups

def list_backups(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::Backup>
def list_backups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::Backup>

Lists Backups in a given project and location.

Overloads 
def list_backups(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::Backup>
Pass arguments to list_backups via a request object, either of type ListBackupsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::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, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::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. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve data sources for all locations, use "-" for the '{location}' value.
  • 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.
  • view (::Google::Cloud::BackupDR::V1beta::BackupView) — Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::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::BackupDR::V1beta::Backup.
  p item
end

#list_binding_matching_resources

def list_binding_matching_resources(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BindingMatchingResource>
def list_binding_matching_resources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BindingMatchingResource>

Lists Binding Matching Resources for a given AutoProtectionPolicyBinding.

Overloads 
def list_binding_matching_resources(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BindingMatchingResource>
Pass arguments to list_binding_matching_resources via a request object, either of type ListBindingMatchingResourcesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListBindingMatchingResourcesRequest, ::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_binding_matching_resources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::BindingMatchingResource>
Pass arguments to list_binding_matching_resources 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 project, location, auto protection policy and binding for which to retrieve BindingMatchingResources information. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1.
  • page_size (::Integer) — Optional. The maximum number of BindingMatchingResources to return in a single response. The default page size is 100 and maximum page size is 200. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • page_token (::String) — Optional. The value of next_page_token received from a previous ListBindingMatchingResources call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBindingMatchingResources must match the call that provided the page token.
  • filter (::String) — Optional. Field match expression used to filter the results.
  • order_by (::String) — Optional. Field by which to sort the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListBindingMatchingResourcesRequest.new

# Call the list_binding_matching_resources method.
result = client.list_binding_matching_resources 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::BackupDR::V1beta::BindingMatchingResource.
  p item
end

#list_data_source_references

def list_data_source_references(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>
def list_data_source_references(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>

Lists DataSourceReferences for a given project and location.

Overloads 
def list_data_source_references(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>
Pass arguments to list_data_source_references via a request object, either of type ListDataSourceReferencesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListDataSourceReferencesRequest, ::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_data_source_references(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSourceReference>
Pass arguments to list_data_source_references 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 parent resource name. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  • page_token (::String) — Optional. A page token, received from a previous ListDataSourceReferences call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDataSourceReferences must match the call that provided the page token.

  • filter (::String) —

    Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering.

    The following field and operator combinations are supported:

    • data_source_gcp_resource_info.gcp_resourcename with =, !=
    • data_source_gcp_resource_info.type with =, !=
  • order_by (::String) —

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

    Supported fields:

    • data_source
    • data_source_gcp_resource_info.gcp_resourcename
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListDataSourceReferencesRequest.new

# Call the list_data_source_references method.
result = client.list_data_source_references 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::BackupDR::V1beta::DataSourceReference.
  p item
end

#list_data_sources

def list_data_sources(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSource>
def list_data_sources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSource>

Lists DataSources in a given project and location.

Overloads 
def list_data_sources(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSource>
Pass arguments to list_data_sources via a request object, either of type ListDataSourcesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListDataSourcesRequest, ::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_data_sources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::DataSource>
Pass arguments to list_data_sources 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 project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve data sources for all locations, use "-" for the '{location}' value.
  • 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListDataSourcesRequest.new

# Call the list_data_sources method.
result = client.list_data_sources 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::BackupDR::V1beta::DataSource.
  p item
end

#list_management_servers

def list_management_servers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::ManagementServer>
def list_management_servers(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::ManagementServer>

Lists ManagementServers in a given project and location.

Overloads 
def list_management_servers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::ManagementServer>
Pass arguments to list_management_servers via a request object, either of type ListManagementServersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::ListManagementServersRequest, ::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_management_servers(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::BackupDR::V1beta::ManagementServer>
Pass arguments to list_management_servers 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 project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve management servers for all locations, use "-" for the '{location}' value.
  • 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::ListManagementServersRequest.new

# Call the list_management_servers method.
result = client.list_management_servers 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::BackupDR::V1beta::ManagementServer.
  p item
end

#location_client

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

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

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Operations

Get the associated client for long-running operations.

Returns

#restore_backup

def restore_backup(request, options = nil) -> ::Gapic::Operation
def restore_backup(compute_instance_target_environment: nil, disk_target_environment: nil, region_disk_target_environment: nil, compute_instance_restore_properties: nil, disk_restore_properties: nil, name: nil, request_id: nil, clear_overrides_field_mask: nil) -> ::Gapic::Operation

Restore from a Backup

Overloads 
def restore_backup(request, options = nil) -> ::Gapic::Operation
Pass arguments to restore_backup via a request object, either of type RestoreBackupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::RestoreBackupRequest, ::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_backup(compute_instance_target_environment: nil, disk_target_environment: nil, region_disk_target_environment: nil, compute_instance_restore_properties: nil, disk_restore_properties: nil, name: nil, request_id: nil, clear_overrides_field_mask: nil) -> ::Gapic::Operation
Pass arguments to restore_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
  • compute_instance_target_environment (::Google::Cloud::BackupDR::V1beta::ComputeInstanceTargetEnvironment, ::Hash) — Compute Engine target environment to be used during restore.

    Note: The following parameters are mutually exclusive: compute_instance_target_environment, disk_target_environment, region_disk_target_environment. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • disk_target_environment (::Google::Cloud::BackupDR::V1beta::DiskTargetEnvironment, ::Hash) — Disk target environment to be used during restore.

    Note: The following parameters are mutually exclusive: disk_target_environment, compute_instance_target_environment, region_disk_target_environment. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • region_disk_target_environment (::Google::Cloud::BackupDR::V1beta::RegionDiskTargetEnvironment, ::Hash) — Region disk target environment to be used during restore.

    Note: The following parameters are mutually exclusive: region_disk_target_environment, compute_instance_target_environment, disk_target_environment. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • compute_instance_restore_properties (::Google::Cloud::BackupDR::V1beta::ComputeInstanceRestoreProperties, ::Hash) — Compute Engine instance properties to be overridden during restore.

    Note: The following parameters are mutually exclusive: compute_instance_restore_properties, disk_restore_properties. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • disk_restore_properties (::Google::Cloud::BackupDR::V1beta::DiskRestoreProperties, ::Hash) — Disk properties to be overridden during restore.

    Note: The following parameters are mutually exclusive: disk_restore_properties, compute_instance_restore_properties. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • name (::String) — Required. The resource name of the Backup instance, in the format 'projects//locations//backupVaults//dataSources//backups/'.
  • 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).

  • clear_overrides_field_mask (::Google::Protobuf::FieldMask, ::Hash) —

    Optional. A field mask used to clear server-side default values for fields within the instance_properties oneof.

    When a field in this mask is cleared, the server will not apply its default logic (like inheriting a value from the source) for that field.

    The most common current use case is clearing default encryption keys.

    Examples of field mask paths:

    • Compute Instance Disks: compute_instance_restore_properties.disks.*.disk_encryption_key
    • Single Disk: disk_restore_properties.disk_encryption_key
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::RestoreBackupRequest.new

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

#trigger_backup

def trigger_backup(request, options = nil) -> ::Gapic::Operation
def trigger_backup(name: nil, rule_id: nil, request_id: nil, custom_retention_days: nil, labels: nil) -> ::Gapic::Operation

Triggers a new Backup.

Overloads 
def trigger_backup(request, options = nil) -> ::Gapic::Operation
Pass arguments to trigger_backup via a request object, either of type TriggerBackupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::TriggerBackupRequest, ::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 trigger_backup(name: nil, rule_id: nil, request_id: nil, custom_retention_days: nil, labels: nil) -> ::Gapic::Operation
Pass arguments to trigger_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 backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
  • rule_id (::String) — Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
  • 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).

  • custom_retention_days (::Integer) — Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
  • labels (::Hash{::String => ::String}) — Optional. Labels to be applied on the backup.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::TriggerBackupRequest.new

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_auto_protection_policy

def update_auto_protection_policy(request, options = nil) -> ::Gapic::Operation
def update_auto_protection_policy(auto_protection_policy: nil, update_mask: nil) -> ::Gapic::Operation

Updates the parameters of a single AutoProtectionPolicy.

Overloads 
def update_auto_protection_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_auto_protection_policy via a request object, either of type UpdateAutoProtectionPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::UpdateAutoProtectionPolicyRequest, ::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_auto_protection_policy(auto_protection_policy: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_auto_protection_policy 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
  • auto_protection_policy (::Google::Cloud::BackupDR::V1beta::AutoProtectionPolicy, ::Hash) — Required. The policy to update.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::UpdateAutoProtectionPolicyRequest.new

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

def update_backup(request, options = nil) -> ::Gapic::Operation
def update_backup(update_mask: nil, backup: nil, request_id: nil) -> ::Gapic::Operation

Updates the settings of a 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::BackupDR::V1beta::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) -> ::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) — Required. 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 the request will fail.
  • backup (::Google::Cloud::BackupDR::V1beta::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).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::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_backup_plan

def update_backup_plan(request, options = nil) -> ::Gapic::Operation
def update_backup_plan(backup_plan: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Update a BackupPlan.

Overloads 
def update_backup_plan(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_backup_plan via a request object, either of type UpdateBackupPlanRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::UpdateBackupPlanRequest, ::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_plan(backup_plan: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_backup_plan 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_plan (::Google::Cloud::BackupDR::V1beta::BackupPlan, ::Hash) — Required. The resource being updated
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan 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 the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.
  • 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 t he 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::UpdateBackupPlanRequest.new

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

def update_backup_plan_association(request, options = nil) -> ::Gapic::Operation
def update_backup_plan_association(backup_plan_association: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Update a BackupPlanAssociation.

Overloads 
def update_backup_plan_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_backup_plan_association via a request object, either of type UpdateBackupPlanAssociationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::UpdateBackupPlanAssociationRequest, ::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_plan_association(backup_plan_association: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_backup_plan_association 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_plan_association (::Google::Cloud::BackupDR::V1beta::BackupPlanAssociation, ::Hash) — Required. The resource being updated
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlanAssociation 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 the request will fail. Currently backup_plan_association.backup_plan is the only supported 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 since the first request.

    For example, consider a situation where you make an initial request and t he 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::UpdateBackupPlanAssociationRequest.new

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

def update_backup_vault(request, options = nil) -> ::Gapic::Operation
def update_backup_vault(update_mask: nil, backup_vault: nil, request_id: nil, validate_only: nil, force: nil, force_update_access_restriction: nil) -> ::Gapic::Operation

Updates the settings of a BackupVault.

Overloads 
def update_backup_vault(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_backup_vault via a request object, either of type UpdateBackupVaultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::UpdateBackupVaultRequest, ::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_vault(update_mask: nil, backup_vault: nil, request_id: nil, validate_only: nil, force: nil, force_update_access_restriction: nil) -> ::Gapic::Operation
Pass arguments to update_backup_vault 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) — Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail.
  • backup_vault (::Google::Cloud::BackupDR::V1beta::BackupVault, ::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. Only validate the request, but do not perform mutations. The default is 'false'.
  • force (::Boolean) — Optional. If set to true, will not check plan duration against backup vault enforcement duration.
  • force_update_access_restriction (::Boolean) — Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::UpdateBackupVaultRequest.new

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

def update_data_source(request, options = nil) -> ::Gapic::Operation
def update_data_source(update_mask: nil, data_source: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation

Updates the settings of a DataSource.

Overloads 
def update_data_source(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_data_source via a request object, either of type UpdateDataSourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BackupDR::V1beta::UpdateDataSourceRequest, ::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_data_source(update_mask: nil, data_source: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation
Pass arguments to update_data_source 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) — Required. Field mask is used to specify the fields to be overwritten in the DataSource 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 the request will fail.
  • data_source (::Google::Cloud::BackupDR::V1beta::DataSource, ::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).

  • allow_missing (::Boolean) — Optional. Enable upsert.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/backupdr/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BackupDR::V1beta::BackupDR::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BackupDR::V1beta::UpdateDataSourceRequest.new

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