Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::RestorePlan.
The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backup_plan
def backup_plan() -> ::String
-
(::String) — Required. Immutable. A reference to the
BackupPlan from which Backups may
be used as the source for Restores created via this RestorePlan. Format:
projects/*/locations/*/backupPlans/*
.
#backup_plan=
def backup_plan=(value) -> ::String
-
value (::String) — Required. Immutable. A reference to the
BackupPlan from which Backups may
be used as the source for Restores created via this RestorePlan. Format:
projects/*/locations/*/backupPlans/*
.
-
(::String) — Required. Immutable. A reference to the
BackupPlan from which Backups may
be used as the source for Restores created via this RestorePlan. Format:
projects/*/locations/*/backupPlans/*
.
#cluster
def cluster() -> ::String
-
(::String) —
Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:
projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*
#cluster=
def cluster=(value) -> ::String
-
value (::String) —
Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:
projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*
-
(::String) —
Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:
projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when this RestorePlan resource was created.
#description
def description() -> ::String
- (::String) — Optional. User specified descriptive string for this RestorePlan.
#description=
def description=(value) -> ::String
- value (::String) — Optional. User specified descriptive string for this RestorePlan.
- (::String) — Optional. User specified descriptive string for this RestorePlan.
#etag
def etag() -> ::String
-
(::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 toGetRestorePlan
, and systems are expected to put that etag in the request toUpdateRestorePlan
orDeleteRestorePlan
to ensure that their change will be applied to the same version of the resource.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
- (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
#name
def name() -> ::String
-
(::String) — Output only. The full name of the RestorePlan resource.
Format:
projects/*/locations/*/restorePlans/*
.
#restore_config
def restore_config() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig
- (::Google::Cloud::GkeBackup::V1::RestoreConfig) — Required. Configuration of Restores created via this RestorePlan.
#restore_config=
def restore_config=(value) -> ::Google::Cloud::GkeBackup::V1::RestoreConfig
- value (::Google::Cloud::GkeBackup::V1::RestoreConfig) — Required. Configuration of Restores created via this RestorePlan.
- (::Google::Cloud::GkeBackup::V1::RestoreConfig) — Required. Configuration of Restores created via this RestorePlan.
#state
def state() -> ::Google::Cloud::GkeBackup::V1::RestorePlan::State
- (::Google::Cloud::GkeBackup::V1::RestorePlan::State) — Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.
#state_reason
def state_reason() -> ::String
-
(::String) — Output only. Human-readable description of why RestorePlan is in the
current
state
#uid
def uid() -> ::String
- (::String) — Output only. Server generated global unique identifier of UUID format.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when this RestorePlan resource was last updated.