Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::Restore.
Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 18
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backup
def backup() -> ::String
Returns
- (::String) — Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects//locations//backupPlans//backups/.
#backup=
def backup=(value) -> ::String
Parameter
- value (::String) — Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects//locations//backupPlans//backups/.
Returns
- (::String) — Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects//locations//backupPlans//backups/.
#cluster
def cluster() -> ::String
Returns
-
(::String) — Output only. The target cluster into which this Restore will restore data.
Valid formats:
- projects//locations//clusters/*
- projects//zones//clusters/*
Inherited from parent RestorePlan's cluster value.
#complete_time
def complete_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp of when the restore operation completed.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when this Restore resource was created.
#description
def description() -> ::String
Returns
- (::String) — User specified descriptive string for this Restore.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — User specified descriptive string for this Restore.
Returns
- (::String) — User specified descriptive string for this Restore.
#etag
def etag() -> ::String
Returns
-
(::String) — Output only.
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of theetag
in the read-modify-write cycle to perform restore updates in order to avoid race conditions: Anetag
is returned in the response toGetRestore
, and systems are expected to put that etag in the request toUpdateRestore
orDeleteRestore
to ensure that their change will be applied to the same version of the resource.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — A set of custom labels supplied by user.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — A set of custom labels supplied by user.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — A set of custom labels supplied by user.
#name
def name() -> ::String
Returns
- (::String) — Output only. The full name of the Restore resource. Format: projects//locations//restorePlans//restores/
#resources_excluded_count
def resources_excluded_count() -> ::Integer
Returns
- (::Integer) — Output only. Number of resources excluded during the restore execution.
#resources_failed_count
def resources_failed_count() -> ::Integer
Returns
- (::Integer) — Output only. Number of resources that failed to be restored during the restore execution.
#resources_restored_count
def resources_restored_count() -> ::Integer
Returns
- (::Integer) — Output only. Number of resources restored during the restore execution.
#restore_config
def restore_config() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig
Returns
- (::Google::Cloud::GkeBackup::V1::RestoreConfig) — Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
#state
def state() -> ::Google::Cloud::GkeBackup::V1::Restore::State
Returns
- (::Google::Cloud::GkeBackup::V1::Restore::State) — Output only. The current state of the Restore.
#state_reason
def state_reason() -> ::String
Returns
- (::String) — Output only. Human-readable description of why the Restore is in its current state.
#uid
def uid() -> ::String
Returns
- (::String) — Output only. Server generated global unique identifier of UUID format.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when this Restore resource was last updated.
#volumes_restored_count
def volumes_restored_count() -> ::Integer
Returns
- (::Integer) — Output only. Number of volumes restored during the restore execution.