Class: Google::Cloud::GkeBackup::V1::Restore
- Inherits:
-
Object
- Object
- Google::Cloud::GkeBackup::V1::Restore
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/gkebackup/v1/restore.rb
Overview
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
Defined Under Namespace
Modules: State Classes: LabelsEntry
Instance Attribute Summary collapse
-
#backup ⇒ ::String
Required.
-
#cluster ⇒ ::String
readonly
Output only.
-
#complete_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#description ⇒ ::String
User specified descriptive string for this Restore.
-
#etag ⇒ ::String
readonly
Output only.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
A set of custom labels supplied by user.
-
#name ⇒ ::String
readonly
Output only.
-
#resources_excluded_count ⇒ ::Integer
readonly
Output only.
-
#resources_failed_count ⇒ ::Integer
readonly
Output only.
-
#resources_restored_count ⇒ ::Integer
readonly
Output only.
-
#restore_config ⇒ ::Google::Cloud::GkeBackup::V1::RestoreConfig
readonly
Output only.
-
#state ⇒ ::Google::Cloud::GkeBackup::V1::Restore::State
readonly
Output only.
-
#state_reason ⇒ ::String
readonly
Output only.
-
#uid ⇒ ::String
readonly
Output only.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#volumes_restored_count ⇒ ::Integer
readonly
Output only.
Instance Attribute Details
#backup ⇒ ::String
Returns 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/.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#cluster ⇒ ::String (readonly)
Returns 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.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#complete_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. Timestamp of when the restore operation completed.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The timestamp when this Restore resource was created.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#description ⇒ ::String
Returns User specified descriptive string for this Restore.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#etag ⇒ ::String (readonly)
Returns 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 the etag
in the
read-modify-write cycle to perform restore updates in order to avoid
race conditions: An etag
is returned in the response to GetRestore
,
and systems are expected to put that etag in the request to
UpdateRestore
or DeleteRestore
to ensure that their change will be
applied to the same version of the resource.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns A set of custom labels supplied by user.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#name ⇒ ::String (readonly)
Returns Output only. The full name of the Restore resource. Format: projects//locations//restorePlans//restores/.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#resources_excluded_count ⇒ ::Integer (readonly)
Returns Output only. Number of resources excluded during the restore execution.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#resources_failed_count ⇒ ::Integer (readonly)
Returns Output only. Number of resources that failed to be restored during the restore execution.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#resources_restored_count ⇒ ::Integer (readonly)
Returns Output only. Number of resources restored during the restore execution.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#restore_config ⇒ ::Google::Cloud::GkeBackup::V1::RestoreConfig (readonly)
Returns Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#state ⇒ ::Google::Cloud::GkeBackup::V1::Restore::State (readonly)
Returns Output only. The current state of the Restore.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#state_reason ⇒ ::String (readonly)
Returns Output only. Human-readable description of why the Restore is in its current state.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#uid ⇒ ::String (readonly)
Returns Output only. Server generated global unique identifier of UUID format.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The timestamp when this Restore resource was last updated.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |
#volumes_restored_count ⇒ ::Integer (readonly)
Returns Output only. Number of volumes restored during the restore execution.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 99 class Restore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Possible values for state of the Restore. module State # The Restore resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Restore resource has been created and the associated RestoreJob # Kubernetes resource has been injected into target cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the restore # operation. IN_PROGRESS = 2 # The restore operation has completed successfully. Restored workloads may # not yet be operational. SUCCEEDED = 3 # The restore operation has failed. FAILED = 4 # This Restore resource is in the process of being deleted. DELETING = 5 end end |