Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::BackupForGKE::Rest::ServiceStub.
REST service stub for the BackupForGKE service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#create_backup
def create_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_backup REST call
- request_pb (::Google::Cloud::GkeBackup::V1::CreateBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_backup_plan
def create_backup_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_backup_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::CreateBackupPlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_restore
def create_restore(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_restore REST call
- request_pb (::Google::Cloud::GkeBackup::V1::CreateRestoreRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_restore_plan
def create_restore_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_restore_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::CreateRestorePlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_backup
def delete_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_backup REST call
- request_pb (::Google::Cloud::GkeBackup::V1::DeleteBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_backup_plan
def delete_backup_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_backup_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::DeleteBackupPlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_restore
def delete_restore(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_restore REST call
- request_pb (::Google::Cloud::GkeBackup::V1::DeleteRestoreRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_restore_plan
def delete_restore_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_restore_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::DeleteRestorePlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#get_backup
def get_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::Backup
Baseline implementation for the get_backup REST call
- request_pb (::Google::Cloud::GkeBackup::V1::GetBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::Backup)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::Backup) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_backup_index_download_url
def get_backup_index_download_url(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::GetBackupIndexDownloadUrlResponse
Baseline implementation for the get_backup_index_download_url REST call
- request_pb (::Google::Cloud::GkeBackup::V1::GetBackupIndexDownloadUrlRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::GetBackupIndexDownloadUrlResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::GetBackupIndexDownloadUrlResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_backup_plan
def get_backup_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::BackupPlan
Baseline implementation for the get_backup_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::GetBackupPlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::BackupPlan)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::BackupPlan) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_restore
def get_restore(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::Restore
Baseline implementation for the get_restore REST call
- request_pb (::Google::Cloud::GkeBackup::V1::GetRestoreRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::Restore)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::Restore) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_restore_plan
def get_restore_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::RestorePlan
Baseline implementation for the get_restore_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::GetRestorePlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::RestorePlan)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::RestorePlan) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_volume_backup
def get_volume_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::VolumeBackup
Baseline implementation for the get_volume_backup REST call
- request_pb (::Google::Cloud::GkeBackup::V1::GetVolumeBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::VolumeBackup)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::VolumeBackup) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_volume_restore
def get_volume_restore(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::VolumeRestore
Baseline implementation for the get_volume_restore REST call
- request_pb (::Google::Cloud::GkeBackup::V1::GetVolumeRestoreRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::VolumeRestore)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::VolumeRestore) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_backup_plans
def list_backup_plans(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse
Baseline implementation for the list_backup_plans REST call
- request_pb (::Google::Cloud::GkeBackup::V1::ListBackupPlansRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_backups
def list_backups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::ListBackupsResponse
Baseline implementation for the list_backups REST call
- request_pb (::Google::Cloud::GkeBackup::V1::ListBackupsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::ListBackupsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::ListBackupsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_restore_plans
def list_restore_plans(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse
Baseline implementation for the list_restore_plans REST call
- request_pb (::Google::Cloud::GkeBackup::V1::ListRestorePlansRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_restores
def list_restores(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::ListRestoresResponse
Baseline implementation for the list_restores REST call
- request_pb (::Google::Cloud::GkeBackup::V1::ListRestoresRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::ListRestoresResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::ListRestoresResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_volume_backups
def list_volume_backups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse
Baseline implementation for the list_volume_backups REST call
- request_pb (::Google::Cloud::GkeBackup::V1::ListVolumeBackupsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_volume_restores
def list_volume_restores(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse
Baseline implementation for the list_volume_restores REST call
- request_pb (::Google::Cloud::GkeBackup::V1::ListVolumeRestoresRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_backup
def update_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_backup REST call
- request_pb (::Google::Cloud::GkeBackup::V1::UpdateBackupRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_backup_plan
def update_backup_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_backup_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::UpdateBackupPlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_restore
def update_restore(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_restore REST call
- request_pb (::Google::Cloud::GkeBackup::V1::UpdateRestoreRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_restore_plan
def update_restore_plan(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_restore_plan REST call
- request_pb (::Google::Cloud::GkeBackup::V1::UpdateRestorePlanRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)