Class: Google::Apis::GkebackupV1::BackupforGKEService

Inherits:

Core::BaseService

• Object
• Core::BaseService
• Google::Apis::GkebackupV1::BackupforGKEService

Defined in:

lib/google/apis/gkebackup_v1/service.rb

Overview

Backup for GKE API

Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.

Examples:

require 'google/apis/gkebackup_v1'

Gkebackup = Google::Apis::GkebackupV1 # Alias the module
service = Gkebackup::BackupforGKEService.new

See Also:

• https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke

Constant Summary

DEFAULT_ENDPOINT_TEMPLATE =

"https://gkebackup.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  Available to use for quota purposes for server-side applications.

Instance Method Summary

• #cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Empty

  Starts asynchronous cancellation on a long-running operation.

• #create_project_location_backup_channel(parent, backup_channel_object = nil, backup_channel_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Creates a new BackupChannel in a given location.

• #create_project_location_backup_plan(parent, backup_plan_object = nil, backup_plan_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Creates a new BackupPlan in a given location.

• #create_project_location_backup_plan_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Creates a Backup for the given BackupPlan.

• #create_project_location_restore_channel(parent, restore_channel_object = nil, restore_channel_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Creates a new RestoreChannel in a given location.

• #create_project_location_restore_plan(parent, restore_plan_object = nil, restore_plan_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Creates a new RestorePlan in a given location.

• #create_project_location_restore_plan_restore(parent, restore_object = nil, restore_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Creates a new Restore for the given RestorePlan.

• #delete_project_location_backup_channel(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Deletes an existing BackupChannel.

• #delete_project_location_backup_plan(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Deletes an existing BackupPlan.

• #delete_project_location_backup_plan_backup(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Deletes an existing Backup.

• #delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Empty

  Deletes a long-running operation.

• #delete_project_location_restore_channel(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Deletes an existing RestoreChannel.

• #delete_project_location_restore_plan(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Deletes an existing RestorePlan.

• #delete_project_location_restore_plan_restore(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Deletes an existing Restore.

• #get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Location

  Gets information about a location.

• #get_project_location_backup_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::BackupChannel

  Retrieve the details of a single BackupChannel.

• #get_project_location_backup_channel_backup_plan_binding(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::BackupPlanBinding

  Retrieve the details of a single BackupPlanBinding.

• #get_project_location_backup_plan(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::BackupPlan

  Retrieve the details of a single BackupPlan.

• #get_project_location_backup_plan_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Backup

  Retrieve the details of a single Backup.

• #get_project_location_backup_plan_backup_backup_index_download_url(backup, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse

  Retrieve the link to the backupIndex.

• #get_project_location_backup_plan_backup_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Gets the access control policy for a resource.

• #get_project_location_backup_plan_backup_volume_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::VolumeBackup

  Retrieve the details of a single VolumeBackup.

• #get_project_location_backup_plan_backup_volume_backup_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Gets the access control policy for a resource.

• #get_project_location_backup_plan_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Gets the access control policy for a resource.

• #get_project_location_backup_plan_tags(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GetTagsResponse

  Returns tags directly bound to a GCP resource.

• #get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Gets the latest state of a long-running operation.

• #get_project_location_restore_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::RestoreChannel

  Retrieve the details of a single RestoreChannel.

• #get_project_location_restore_channel_restore_plan_binding(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::RestorePlanBinding

  Retrieve the details of a single RestorePlanBinding.

• #get_project_location_restore_plan(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::RestorePlan

  Retrieve the details of a single RestorePlan.

• #get_project_location_restore_plan_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Gets the access control policy for a resource.

• #get_project_location_restore_plan_restore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Restore

  Retrieves the details of a single Restore.

• #get_project_location_restore_plan_restore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Gets the access control policy for a resource.

• #get_project_location_restore_plan_restore_volume_restore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::VolumeRestore

  Retrieve the details of a single VolumeRestore.

• #get_project_location_restore_plan_restore_volume_restore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Gets the access control policy for a resource.

• #get_project_location_restore_plan_tags(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GetTagsResponse

  Returns tags directly bound to a GCP resource.

• #initialize ⇒ BackupforGKEService constructor

  A new instance of BackupforGKEService.

• #list_project_location_backup_channel_backup_plan_bindings(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupPlanBindingsResponse

  Lists BackupPlanBindings in a given location.

• #list_project_location_backup_channels(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupChannelsResponse

  Lists BackupChannels in a given location.

• #list_project_location_backup_plan_backup_volume_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListVolumeBackupsResponse

  Lists the VolumeBackups for a given Backup.

• #list_project_location_backup_plan_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupsResponse

  Lists the Backups for a given BackupPlan.

• #list_project_location_backup_plans(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupPlansResponse

  Lists BackupPlans in a given location.

• #list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningListOperationsResponse

  Lists operations that match the specified filter in the request.

• #list_project_location_restore_channel_restore_plan_bindings(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestorePlanBindingsResponse

  Lists RestorePlanBindings in a given location.

• #list_project_location_restore_channels(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestoreChannelsResponse

  Lists RestoreChannels in a given location.

• #list_project_location_restore_plan_restore_volume_restores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListVolumeRestoresResponse

  Lists the VolumeRestores for a given Restore.

• #list_project_location_restore_plan_restores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestoresResponse

  Lists the Restores for a given RestorePlan.

• #list_project_location_restore_plans(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestorePlansResponse

  Lists RestorePlans in a given location.

• #list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListLocationsResponse

  Lists information about the supported locations for this service.

• #patch_project_location_backup_channel(name, backup_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Update a BackupChannel.

• #patch_project_location_backup_plan(name, backup_plan_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Update a BackupPlan.

• #patch_project_location_backup_plan_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Update a Backup.

• #patch_project_location_restore_channel(name, restore_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Update a RestoreChannel.

• #patch_project_location_restore_plan(name, restore_plan_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Update a RestorePlan.

• #patch_project_location_restore_plan_restore(name, restore_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

  Update a Restore.

• #set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Sets the access control policy on the specified resource.

• #set_backup_plan_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Sets the access control policy on the specified resource.

• #set_backup_plan_tags(name, set_tags_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::SetTagsResponse

  Updates tags directly bound to a GCP resource.

• #set_restore_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Sets the access control policy on the specified resource.

• #set_restore_plan_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Sets the access control policy on the specified resource.

• #set_restore_plan_tags(name, set_tags_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::SetTagsResponse

  Updates tags directly bound to a GCP resource.

• #set_volume_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Sets the access control policy on the specified resource.

• #set_volume_restore_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

  Sets the access control policy on the specified resource.

• #test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

  Returns permissions that a caller has on the specified resource.

• #test_backup_plan_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

  Returns permissions that a caller has on the specified resource.

• #test_restore_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

  Returns permissions that a caller has on the specified resource.

• #test_restore_plan_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

  Returns permissions that a caller has on the specified resource.

• #test_volume_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

  Returns permissions that a caller has on the specified resource.

• #test_volume_restore_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

  Returns permissions that a caller has on the specified resource.

Constructor Details

#initialize ⇒ BackupforGKEService

Returns a new instance of BackupforGKEService.

# File 'lib/google/apis/gkebackup_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-gkebackup_v1',
        client_version: Google::Apis::GkebackupV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

• (String) —

  API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

# File 'lib/google/apis/gkebackup_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

• (String) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

# File 'lib/google/apis/gkebackup_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

• name (String) —

  The name of the operation resource to be cancelled.

• google_longrunning_cancel_operation_request_object (Google::Apis::GkebackupV1::GoogleLongrunningCancelOperationRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1405

def cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::GkebackupV1::GoogleLongrunningCancelOperationRequest::Representation
  command.request_object = google_longrunning_cancel_operation_request_object
  command.response_representation = Google::Apis::GkebackupV1::Empty::Representation
  command.response_class = Google::Apis::GkebackupV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_backup_channel(parent, backup_channel_object = nil, backup_channel_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Creates a new BackupChannel in a given location.

Parameters:

• parent (String) —

  Required. The location within which to create the BackupChannel. Format: projects/*/locations/*

• backup_channel_object (Google::Apis::GkebackupV1::BackupChannel) (defaults to: nil)
• backup_channel_id (String) (defaults to: nil) —

  Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter

  • end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 170

def create_project_location_backup_channel(parent, backup_channel_object = nil, backup_channel_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/backupChannels', options)
  command.request_representation = Google::Apis::GkebackupV1::BackupChannel::Representation
  command.request_object = backup_channel_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['backupChannelId'] = backup_channel_id unless backup_channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_backup_plan(parent, backup_plan_object = nil, backup_plan_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Creates a new BackupPlan in a given location.

Parameters:

• parent (String) —

  Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

• backup_plan_object (Google::Apis::GkebackupV1::BackupPlan) (defaults to: nil)
• backup_plan_id (String) (defaults to: nil) —

  Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter

  • end with a lower-case letter or number - be unique within the set of BackupPlans in this location
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 457

def create_project_location_backup_plan(parent, backup_plan_object = nil, backup_plan_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/backupPlans', options)
  command.request_representation = Google::Apis::GkebackupV1::BackupPlan::Representation
  command.request_object = backup_plan_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['backupPlanId'] = backup_plan_id unless backup_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_backup_plan_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Creates a Backup for the given BackupPlan.

Parameters:

• parent (String) —

  Required. The BackupPlan within which to create the Backup. Format: projects/* /locations/*/backupPlans/*

• backup_object (Google::Apis::GkebackupV1::Backup) (defaults to: nil)
• backup_id (String) (defaults to: nil) —

  Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter

  • end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 842

def create_project_location_backup_plan_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/backups', options)
  command.request_representation = Google::Apis::GkebackupV1::Backup::Representation
  command.request_object = backup_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['backupId'] = backup_id unless backup_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_restore_channel(parent, restore_channel_object = nil, restore_channel_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Creates a new RestoreChannel in a given location.

Parameters:

• parent (String) —

  Required. The location within which to create the RestoreChannel. Format: projects/*/locations/*

• restore_channel_object (Google::Apis::GkebackupV1::RestoreChannel) (defaults to: nil)
• restore_channel_id (String) (defaults to: nil) —

  Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter

  • end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1559

def create_project_location_restore_channel(parent, restore_channel_object = nil, restore_channel_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/restoreChannels', options)
  command.request_representation = Google::Apis::GkebackupV1::RestoreChannel::Representation
  command.request_object = restore_channel_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['restoreChannelId'] = restore_channel_id unless restore_channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_restore_plan(parent, restore_plan_object = nil, restore_plan_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Creates a new RestorePlan in a given location.

Parameters:

• parent (String) —

  Required. The location within which to create the RestorePlan. Format: projects/*/locations/*

• restore_plan_object (Google::Apis::GkebackupV1::RestorePlan) (defaults to: nil)
• restore_plan_id (String) (defaults to: nil) —

  Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter

  • end with a lower-case letter or number - be unique within the set of RestorePlans in this location
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1841

def create_project_location_restore_plan(parent, restore_plan_object = nil, restore_plan_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/restorePlans', options)
  command.request_representation = Google::Apis::GkebackupV1::RestorePlan::Representation
  command.request_object = restore_plan_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['restorePlanId'] = restore_plan_id unless restore_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_restore_plan_restore(parent, restore_object = nil, restore_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Creates a new Restore for the given RestorePlan.

Parameters:

• parent (String) —

  Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

• restore_object (Google::Apis::GkebackupV1::Restore) (defaults to: nil)
• restore_id (String) (defaults to: nil) —

  Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter

  • end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2230

def create_project_location_restore_plan_restore(parent, restore_object = nil, restore_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/restores', options)
  command.request_representation = Google::Apis::GkebackupV1::Restore::Representation
  command.request_object = restore_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['restoreId'] = restore_id unless restore_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_backup_channel(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Deletes an existing BackupChannel.

Parameters:

• name (String) —

  Required. Fully qualified BackupChannel name. Format: projects/*/locations/*/ backupChannels/*

• etag (String) (defaults to: nil) —

  Optional. If provided, this value must match the current value of the target BackupChannel's etag field or the request is rejected.

• force (Boolean) (defaults to: nil) —

  Optional. If set to true, any BackupPlanAssociations below this BackupChannel will also be deleted. Otherwise, the request will only succeed if the BackupChannel has no BackupPlanAssociations.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 211

def delete_project_location_backup_channel(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_backup_plan(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Deletes an existing BackupPlan.

Parameters:

• name (String) —

  Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/ backupPlans/*

• etag (String) (defaults to: nil) —

  Optional. If provided, this value must match the current value of the target BackupPlan's etag field or the request is rejected.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 494

def delete_project_location_backup_plan(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_backup_plan_backup(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Deletes an existing Backup.

Parameters:

• name (String) —

  Required. Name of the Backup resource. Format: projects/*/locations/*/ backupPlans/*/backups/*

• etag (String) (defaults to: nil) —

  Optional. If provided, this value must match the current value of the target Backup's etag field or the request is rejected.

• force (Boolean) (defaults to: nil) —

  Optional. If set to true, any VolumeBackups below this Backup will also be deleted. Otherwise, the request will only succeed if the Backup has no VolumeBackups.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 883

def delete_project_location_backup_plan_backup(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

• name (String) —

  The name of the operation resource to be deleted.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1440

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::Empty::Representation
  command.response_class = Google::Apis::GkebackupV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_restore_channel(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Deletes an existing RestoreChannel.

Parameters:

• name (String) —

  Required. Fully qualified RestoreChannel name. Format: projects/*/locations/*/ restoreChannels/*

• etag (String) (defaults to: nil) —

  Optional. If provided, this value must match the current value of the target RestoreChannel's etag field or the request is rejected.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1596

def delete_project_location_restore_channel(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_restore_plan(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Deletes an existing RestorePlan.

Parameters:

• name (String) —

  Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/ restorePlans/*

• etag (String) (defaults to: nil) —

  Optional. If provided, this value must match the current value of the target RestorePlan's etag field or the request is rejected.

• force (Boolean) (defaults to: nil) —

  Optional. If set to true, any Restores below this RestorePlan will also be deleted. Otherwise, the request will only succeed if the RestorePlan has no Restores.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1882

def delete_project_location_restore_plan(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_restore_plan_restore(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Deletes an existing Restore.

Parameters:

• name (String) —

  Required. Full name of the Restore Format: projects/*/locations/*/ restorePlans/*/restores/*

• etag (String) (defaults to: nil) —

  Optional. If provided, this value must match the current value of the target Restore's etag field or the request is rejected.

• force (Boolean) (defaults to: nil) —

  Optional. If set to true, any VolumeRestores below this restore will also be deleted. Otherwise, the request will only succeed if the restore has no VolumeRestores.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2271

def delete_project_location_restore_plan_restore(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Location

Gets information about a location.

Parameters:

• name (String) —

  Resource name for the location.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Location) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Location)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 75

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::Location::Representation
  command.response_class = Google::Apis::GkebackupV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::BackupChannel

Retrieve the details of a single BackupChannel.

Parameters:

• name (String) —

  Required. Fully qualified BackupChannel name. Format: projects/*/locations/*/ backupChannels/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::BackupChannel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::BackupChannel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 244

def get_project_location_backup_channel(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::BackupChannel::Representation
  command.response_class = Google::Apis::GkebackupV1::BackupChannel
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_channel_backup_plan_binding(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::BackupPlanBinding

Retrieve the details of a single BackupPlanBinding.

Parameters:

• name (String) —

  Required. Fully qualified BackupPlanBinding name. Format: projects/*/ locations/*/backupChannels/*/backupPlanBindings/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::BackupPlanBinding) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::BackupPlanBinding)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 369

def get_project_location_backup_channel_backup_plan_binding(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::BackupPlanBinding::Representation
  command.response_class = Google::Apis::GkebackupV1::BackupPlanBinding
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::BackupPlan

Retrieve the details of a single BackupPlan.

Parameters:

• name (String) —

  Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/ backupPlans/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::BackupPlan) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::BackupPlan)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 526

def get_project_location_backup_plan(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::BackupPlan::Representation
  command.response_class = Google::Apis::GkebackupV1::BackupPlan
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Backup

Retrieve the details of a single Backup.

Parameters:

• name (String) —

  Required. Full name of the Backup resource. Format: projects/*/locations/*/ backupPlans/*/backups/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Backup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Backup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 916

def get_project_location_backup_plan_backup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::Backup::Representation
  command.response_class = Google::Apis::GkebackupV1::Backup
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan_backup_backup_index_download_url(backup, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse

Retrieve the link to the backupIndex.

Parameters:

• backup (String) —

  Required. Full name of Backup resource. Format: projects/project/locations/ location/backupPlans/backup_plan/backups/backup

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 947

def get_project_location_backup_plan_backup_backup_index_download_url(backup, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+backup}:getBackupIndexDownloadUrl', options)
  command.response_representation = Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse
  command.params['backup'] = backup unless backup.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan_backup_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

• options_requested_policy_version (Fixnum) (defaults to: nil) —

  Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 991

def get_project_location_backup_plan_backup_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan_backup_volume_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::VolumeBackup

Retrieve the details of a single VolumeBackup.

Parameters:

• name (String) —

  Required. Full name of the VolumeBackup resource. Format: projects/*/ locations/*/backupPlans/*/backups/*/volumeBackups/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::VolumeBackup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::VolumeBackup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1196

def get_project_location_backup_plan_backup_volume_backup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::VolumeBackup::Representation
  command.response_class = Google::Apis::GkebackupV1::VolumeBackup
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan_backup_volume_backup_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

• options_requested_policy_version (Fixnum) (defaults to: nil) —

  Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1240

def get_project_location_backup_plan_backup_volume_backup_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

• options_requested_policy_version (Fixnum) (defaults to: nil) —

  Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 570

def get_project_location_backup_plan_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup_plan_tags(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GetTagsResponse

Returns tags directly bound to a GCP resource.

Parameters:

• name (String) —

  Required. The full resource name of the service resource.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GetTagsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GetTagsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 601

def get_project_location_backup_plan_tags(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:getTags', options)
  command.response_representation = Google::Apis::GkebackupV1::GetTagsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::GetTagsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

• name (String) —

  The name of the operation resource.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1471

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::RestoreChannel

Retrieve the details of a single RestoreChannel.

Parameters:

• name (String) —

  Required. Fully qualified RestoreChannel name. Format: projects/*/locations/*/ restoreChannels/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::RestoreChannel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::RestoreChannel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1628

def get_project_location_restore_channel(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::RestoreChannel::Representation
  command.response_class = Google::Apis::GkebackupV1::RestoreChannel
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_channel_restore_plan_binding(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::RestorePlanBinding

Retrieve the details of a single RestorePlanBinding.

Parameters:

• name (String) —

  Required. Fully qualified RestorePlanBinding name. Format: projects/*/ locations/*/restoreChannels/*/restorePlanBindings/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::RestorePlanBinding) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::RestorePlanBinding)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1753

def get_project_location_restore_channel_restore_plan_binding(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::RestorePlanBinding::Representation
  command.response_class = Google::Apis::GkebackupV1::RestorePlanBinding
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_plan(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::RestorePlan

Retrieve the details of a single RestorePlan.

Parameters:

• name (String) —

  Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/ restorePlans/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::RestorePlan) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::RestorePlan)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1915

def get_project_location_restore_plan(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::RestorePlan::Representation
  command.response_class = Google::Apis::GkebackupV1::RestorePlan
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_plan_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

• options_requested_policy_version (Fixnum) (defaults to: nil) —

  Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1959

def get_project_location_restore_plan_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_plan_restore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Restore

Retrieves the details of a single Restore.

Parameters:

• name (String) —

  Required. Name of the restore resource. Format: projects/*/locations/*/ restorePlans/*/restores/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Restore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Restore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2304

def get_project_location_restore_plan_restore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::Restore::Representation
  command.response_class = Google::Apis::GkebackupV1::Restore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_plan_restore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

• options_requested_policy_version (Fixnum) (defaults to: nil) —

  Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2348

def get_project_location_restore_plan_restore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_plan_restore_volume_restore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::VolumeRestore

Retrieve the details of a single VolumeRestore.

Parameters:

• name (String) —

  Required. Full name of the VolumeRestore resource. Format: projects/*/ locations/*/restorePlans/*/restores/*/volumeRestores/*

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::VolumeRestore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::VolumeRestore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2549

def get_project_location_restore_plan_restore_volume_restore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkebackupV1::VolumeRestore::Representation
  command.response_class = Google::Apis::GkebackupV1::VolumeRestore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_plan_restore_volume_restore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

• options_requested_policy_version (Fixnum) (defaults to: nil) —

  Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2593

def get_project_location_restore_plan_restore_volume_restore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_restore_plan_tags(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GetTagsResponse

Returns tags directly bound to a GCP resource.

Parameters:

• name (String) —

  Required. The full resource name of the service resource.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GetTagsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GetTagsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1990

def get_project_location_restore_plan_tags(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:getTags', options)
  command.response_representation = Google::Apis::GkebackupV1::GetTagsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::GetTagsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_backup_channel_backup_plan_bindings(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupPlanBindingsResponse

Lists BackupPlanBindings in a given location.

Parameters:

• parent (String) —

  Required. The BackupChannel that contains the BackupPlanBindings to list. Format: projects/*/locations/*/backupChannels/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListBackupPlanBindings call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackupPlanBindings must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListBackupPlanBindingsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListBackupPlanBindingsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 415

def list_project_location_backup_channel_backup_plan_bindings(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/backupPlanBindings', options)
  command.response_representation = Google::Apis::GkebackupV1::ListBackupPlanBindingsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListBackupPlanBindingsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_backup_channels(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupChannelsResponse

Lists BackupChannels in a given location.

Parameters:

• parent (String) —

  Required. The location that contains the BackupChannels to list. Format: projects/*/locations/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListBackupChannels call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackupChannels must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListBackupChannelsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListBackupChannelsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 290

def list_project_location_backup_channels(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/backupChannels', options)
  command.response_representation = Google::Apis::GkebackupV1::ListBackupChannelsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListBackupChannelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_backup_plan_backup_volume_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListVolumeBackupsResponse

Lists the VolumeBackups for a given Backup.

Parameters:

• parent (String) —

  Required. The Backup that contains the VolumeBackups to list. Format: projects/*/locations/*/backupPlans/*/backups/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListVolumeBackups call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListVolumeBackups must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListVolumeBackupsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListVolumeBackupsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1287

def list_project_location_backup_plan_backup_volume_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/volumeBackups', options)
  command.response_representation = Google::Apis::GkebackupV1::ListVolumeBackupsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListVolumeBackupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_backup_plan_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupsResponse

Lists the Backups for a given BackupPlan.

Parameters:

• parent (String) —

  Required. The BackupPlan that contains the Backups to list. Format: projects/* /locations/*/backupPlans/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListBackups call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.

• return_partial_success (Boolean) (defaults to: nil) —

  Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListBackupsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListBackupsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1041

def list_project_location_backup_plan_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/backups', options)
  command.response_representation = Google::Apis::GkebackupV1::ListBackupsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListBackupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_backup_plans(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListBackupPlansResponse

Lists BackupPlans in a given location.

Parameters:

• parent (String) —

  Required. The location that contains the BackupPlans to list. Format: projects/*/locations/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListBackupPlansResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListBackupPlansResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 647

def list_project_location_backup_plans(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/backupPlans', options)
  command.response_representation = Google::Apis::GkebackupV1::ListBackupPlansResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListBackupPlansResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

• name (String) —

  The name of the operation's parent resource.

• filter (String) (defaults to: nil) —

  The standard list filter.

• page_size (Fixnum) (defaults to: nil) —

  The standard list page size.

• page_token (String) (defaults to: nil) —

  The standard list page token.

• return_partial_success (Boolean) (defaults to: nil) —

  When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningListOperationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningListOperationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1516

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_restore_channel_restore_plan_bindings(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestorePlanBindingsResponse

Lists RestorePlanBindings in a given location.

Parameters:

• parent (String) —

  Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: projects/*/locations/*/restoreChannels/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListRestorePlanBindings call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestorePlanBindings must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListRestorePlanBindingsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListRestorePlanBindingsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1799

def list_project_location_restore_channel_restore_plan_bindings(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/restorePlanBindings', options)
  command.response_representation = Google::Apis::GkebackupV1::ListRestorePlanBindingsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListRestorePlanBindingsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_restore_channels(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestoreChannelsResponse

Lists RestoreChannels in a given location.

Parameters:

• parent (String) —

  Required. The location that contains the RestoreChannels to list. Format: projects/*/locations/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListRestoreChannels call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestoreChannels must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListRestoreChannelsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListRestoreChannelsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1674

def list_project_location_restore_channels(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/restoreChannels', options)
  command.response_representation = Google::Apis::GkebackupV1::ListRestoreChannelsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListRestoreChannelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_restore_plan_restore_volume_restores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListVolumeRestoresResponse

Lists the VolumeRestores for a given Restore.

Parameters:

• parent (String) —

  Required. The Restore that contains the VolumeRestores to list. Format: projects/*/locations/*/restorePlans/*/restores/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListVolumeRestores call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListVolumeRestores must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListVolumeRestoresResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListVolumeRestoresResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2640

def list_project_location_restore_plan_restore_volume_restores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/volumeRestores', options)
  command.response_representation = Google::Apis::GkebackupV1::ListVolumeRestoresResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListVolumeRestoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_restore_plan_restores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestoresResponse

Lists the Restores for a given RestorePlan.

Parameters:

• parent (String) —

  Required. The RestorePlan that contains the Restores to list. Format: projects/*/locations/*/restorePlans/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListRestores call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestores must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListRestoresResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListRestoresResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2395

def list_project_location_restore_plan_restores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/restores', options)
  command.response_representation = Google::Apis::GkebackupV1::ListRestoresResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListRestoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_restore_plans(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListRestorePlansResponse

Lists RestorePlans in a given location.

Parameters:

• parent (String) —

  Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

• filter (String) (defaults to: nil) —

  Optional. Field match expression used to filter the results.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the results.

• page_size (Fixnum) (defaults to: nil) —

  Optional. The target number of results 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) (defaults to: nil) —

  Optional. The value of next_page_token received from a previous ListRestorePlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestorePlans must match the call that provided the page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListRestorePlansResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListRestorePlansResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2036

def list_project_location_restore_plans(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/restorePlans', options)
  command.response_representation = Google::Apis::GkebackupV1::ListRestorePlansResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListRestorePlansResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::ListLocationsResponse

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

• name (String) —

  The resource that owns the locations collection, if applicable.

• extra_location_types (Array<String>, String) (defaults to: nil) —

  Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

• filter (String) (defaults to: nil) —

  A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

• page_size (Fixnum) (defaults to: nil) —

  The maximum number of results to return. If not set, the service selects a default.

• page_token (String) (defaults to: nil) —

  A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::ListLocationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::ListLocationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 127

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::GkebackupV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_backup_channel(name, backup_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Update a BackupChannel.

Parameters:

• name (String) —

  Identifier. The fully qualified name of the BackupChannel. projects/*/ locations/*/backupChannels/*

• backup_channel_object (Google::Apis::GkebackupV1::BackupChannel) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. This is used to specify the fields to be overwritten in the BackupChannel targeted for update. The values for each of these updated fields will be taken from the backup_channel provided with this request. Field names are relative to the root of the resource (e.g., description, labels, etc.) If no update_mask is provided, all fields in backup_channel will be written to the target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_channel are ignored and are not used to update the target BackupChannel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 335

def patch_project_location_backup_channel(name, backup_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkebackupV1::BackupChannel::Representation
  command.request_object = backup_channel_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_backup_plan(name, backup_plan_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Update a BackupPlan.

Parameters:

• name (String) —

  Output only. Identifier. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

• backup_plan_object (Google::Apis::GkebackupV1::BackupPlan) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource (e.g., description, backup_config. include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 692

def patch_project_location_backup_plan(name, backup_plan_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkebackupV1::BackupPlan::Representation
  command.request_object = backup_plan_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_backup_plan_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Update a Backup.

Parameters:

• name (String) —

  Output only. Identifier. The fully qualified name of the Backup. projects/*/ locations/*/backupPlans/*/backups/*

• backup_object (Google::Apis::GkebackupV1::Backup) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in backup will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup are ignored and are not used to update the target Backup.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1086

def patch_project_location_backup_plan_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkebackupV1::Backup::Representation
  command.request_object = backup_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_restore_channel(name, restore_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Update a RestoreChannel.

Parameters:

• name (String) —

  Identifier. The fully qualified name of the RestoreChannel. projects/*/ locations/*/restoreChannels/*

• restore_channel_object (Google::Apis::GkebackupV1::RestoreChannel) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. This is used to specify the fields to be overwritten in the RestoreChannel targeted for update. The values for each of these updated fields will be taken from the restore_channel provided with this request. Field names are relative to the root of the resource (e.g., description, destination_project_id, etc.) If no update_mask is provided, all fields in restore_channel will be written to the target RestoreChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore_channel are ignored and are not used to update the target RestoreChannel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1719

def patch_project_location_restore_channel(name, restore_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkebackupV1::RestoreChannel::Representation
  command.request_object = restore_channel_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_restore_plan(name, restore_plan_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Update a RestorePlan.

Parameters:

• name (String) —

  Output only. Identifier. The full name of the RestorePlan resource. Format: projects/*/locations/*/restorePlans/*.

• restore_plan_object (Google::Apis::GkebackupV1::RestorePlan) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the restore_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore_plan will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore_plan are ignored and are not used to update the target RestorePlan.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2080

def patch_project_location_restore_plan(name, restore_plan_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkebackupV1::RestorePlan::Representation
  command.request_object = restore_plan_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_restore_plan_restore(name, restore_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::GoogleLongrunningOperation

Update a Restore.

Parameters:

• name (String) —

  Output only. Identifier. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

• restore_object (Google::Apis::GkebackupV1::Restore) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the restore provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore are ignored and are not used to update the target Restore.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::GoogleLongrunningOperation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::GoogleLongrunningOperation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2439

def patch_project_location_restore_plan_restore(name, restore_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkebackupV1::Restore::Representation
  command.request_object = restore_object
  command.response_representation = Google::Apis::GkebackupV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::GkebackupV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

• set_iam_policy_request_object (Google::Apis::GkebackupV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1124

def set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkebackupV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_backup_plan_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

• set_iam_policy_request_object (Google::Apis::GkebackupV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 730

def set_backup_plan_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkebackupV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_backup_plan_tags(name, set_tags_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::SetTagsResponse

Updates tags directly bound to a GCP resource.

Parameters:

• name (String) —

  Required. The full resource name of the service resource.

• set_tags_request_object (Google::Apis::GkebackupV1::SetTagsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::SetTagsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::SetTagsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 763

def set_backup_plan_tags(name, set_tags_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:setTags', options)
  command.request_representation = Google::Apis::GkebackupV1::SetTagsRequest::Representation
  command.request_object = set_tags_request_object
  command.response_representation = Google::Apis::GkebackupV1::SetTagsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::SetTagsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_restore_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

• set_iam_policy_request_object (Google::Apis::GkebackupV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2477

def set_restore_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkebackupV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_restore_plan_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

• set_iam_policy_request_object (Google::Apis::GkebackupV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2118

def set_restore_plan_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkebackupV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_restore_plan_tags(name, set_tags_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::SetTagsResponse

Updates tags directly bound to a GCP resource.

Parameters:

• name (String) —

  Required. The full resource name of the service resource.

• set_tags_request_object (Google::Apis::GkebackupV1::SetTagsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::SetTagsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::SetTagsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2151

def set_restore_plan_tags(name, set_tags_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:setTags', options)
  command.request_representation = Google::Apis::GkebackupV1::SetTagsRequest::Representation
  command.request_object = set_tags_request_object
  command.response_representation = Google::Apis::GkebackupV1::SetTagsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::SetTagsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_volume_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

• set_iam_policy_request_object (Google::Apis::GkebackupV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1326

def set_volume_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkebackupV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_volume_restore_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

• set_iam_policy_request_object (Google::Apis::GkebackupV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2679

def set_volume_restore_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkebackupV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkebackupV1::Policy::Representation
  command.response_class = Google::Apis::GkebackupV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

• test_iam_permissions_request_object (Google::Apis::GkebackupV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1163

def test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkebackupV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkebackupV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_backup_plan_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

• test_iam_permissions_request_object (Google::Apis::GkebackupV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 802

def test_backup_plan_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkebackupV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkebackupV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_restore_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

• test_iam_permissions_request_object (Google::Apis::GkebackupV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2516

def test_restore_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkebackupV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkebackupV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_restore_plan_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

• test_iam_permissions_request_object (Google::Apis::GkebackupV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2190

def test_restore_plan_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkebackupV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkebackupV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_volume_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

• test_iam_permissions_request_object (Google::Apis::GkebackupV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 1365

def test_volume_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkebackupV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkebackupV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_volume_restore_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkebackupV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

• test_iam_permissions_request_object (Google::Apis::GkebackupV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GkebackupV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GkebackupV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/gkebackup_v1/service.rb', line 2718

def test_volume_restore_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkebackupV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkebackupV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkebackupV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end