Class: Google::Cloud::GkeBackup::V1::Backup
- Inherits:
-
Object
- Object
- Google::Cloud::GkeBackup::V1::Backup
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/gkebackup/v1/backup.rb
Overview
Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups). Next id: 28
Defined Under Namespace
Modules: State Classes: ClusterMetadata, LabelsEntry
Instance Attribute Summary collapse
-
#all_namespaces ⇒ ::Boolean
readonly
Output only.
-
#cluster_metadata ⇒ ::Google::Cloud::GkeBackup::V1::Backup::ClusterMetadata
readonly
Output only.
-
#complete_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#config_backup_size_bytes ⇒ ::Integer
readonly
Output only.
-
#contains_secrets ⇒ ::Boolean
readonly
Output only.
-
#contains_volume_data ⇒ ::Boolean
readonly
Output only.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#delete_lock_days ⇒ ::Integer
Minimum age for this Backup (in days).
-
#delete_lock_expire_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#description ⇒ ::String
User specified descriptive string for this Backup.
-
#encryption_key ⇒ ::Google::Cloud::GkeBackup::V1::EncryptionKey
readonly
Output only.
-
#etag ⇒ ::String
readonly
Output only.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
A set of custom labels supplied by user.
-
#manual ⇒ ::Boolean
readonly
Output only.
-
#name ⇒ ::String
readonly
Output only.
-
#pod_count ⇒ ::Integer
readonly
Output only.
-
#resource_count ⇒ ::Integer
readonly
Output only.
-
#retain_days ⇒ ::Integer
The age (in days) after which this Backup will be automatically deleted.
-
#retain_expire_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#selected_applications ⇒ ::Google::Cloud::GkeBackup::V1::NamespacedNames
readonly
Output only.
-
#selected_namespaces ⇒ ::Google::Cloud::GkeBackup::V1::Namespaces
readonly
Output only.
-
#size_bytes ⇒ ::Integer
readonly
Output only.
-
#state ⇒ ::Google::Cloud::GkeBackup::V1::Backup::State
readonly
Output only.
-
#state_reason ⇒ ::String
readonly
Output only.
-
#uid ⇒ ::String
readonly
Output only.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#volume_count ⇒ ::Integer
readonly
Output only.
Instance Attribute Details
#all_namespaces ⇒ ::Boolean (readonly)
Returns Output only. If True, all namespaces were included in the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#cluster_metadata ⇒ ::Google::Cloud::GkeBackup::V1::Backup::ClusterMetadata (readonly)
Returns Output only. Information about the GKE cluster from which this Backup was created.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#complete_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. Completion time of the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#config_backup_size_bytes ⇒ ::Integer (readonly)
Returns Output only. The size of the config backup in bytes.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#contains_secrets ⇒ ::Boolean (readonly)
Returns Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#contains_volume_data ⇒ ::Boolean (readonly)
Returns Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The timestamp when this Backup resource was created.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#delete_lock_days ⇒ ::Integer
Returns Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive).
Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#delete_lock_expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#description ⇒ ::String
Returns User specified descriptive string for this Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#encryption_key ⇒ ::Google::Cloud::GkeBackup::V1::EncryptionKey (readonly)
Returns Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) 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 backup from overwriting each other.
It is strongly suggested that systems make use of the etag
in the
read-modify-write cycle to perform backup updates in order to avoid
race conditions: An etag
is returned in the response to GetBackup
,
and systems are expected to put that etag in the request to
UpdateBackup
or DeleteBackup
to ensure that their change will be
applied to the same version of the resource.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) 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.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#manual ⇒ ::Boolean (readonly)
Returns Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#name ⇒ ::String (readonly)
Returns Output only. The fully qualified name of the Backup.
projects/*/locations/*/backupPlans/*/backups/*
.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#pod_count ⇒ ::Integer (readonly)
Returns Output only. The total number of Kubernetes Pods contained in the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#resource_count ⇒ ::Integer (readonly)
Returns Output only. The total number of Kubernetes resources included in the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#retain_days ⇒ ::Integer
Returns The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0:
- If 0, no automatic deletion will occur for this Backup.
- If not 0, this must be >= delete_lock_days and <= 365.
Once a Backup is created, this value may only be increased.
Defaults to the parent BackupPlan's backup_retain_days value.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#retain_expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#selected_applications ⇒ ::Google::Cloud::GkeBackup::V1::NamespacedNames (readonly)
Returns Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#selected_namespaces ⇒ ::Google::Cloud::GkeBackup::V1::Namespaces (readonly)
Returns Output only. If set, the list of namespaces that were included in the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#size_bytes ⇒ ::Integer (readonly)
Returns Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes).
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#state ⇒ ::Google::Cloud::GkeBackup::V1::Backup::State (readonly)
Returns Output only. Current state of the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#state_reason ⇒ ::String (readonly)
Returns Output only. Human-readable description of why the backup is in the current
state
.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#uid ⇒ ::String (readonly)
Returns Output only. Server generated global unique identifier of UUID4.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The timestamp when this Backup resource was last updated.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |
#volume_count ⇒ ::Integer (readonly)
Returns Output only. The total number of volume backups contained in the Backup.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'proto_docs/google/cloud/gkebackup/v1/backup.rb', line 161 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information about the GKE cluster from which this Backup was created. # @!attribute [rw] cluster # @return [::String] # The source cluster from which this Backup was created. # Valid formats: # # - `projects/*/locations/*/clusters/*` # - `projects/*/zones/*/clusters/*` # # This is inherited from the parent BackupPlan's # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field. # @!attribute [rw] k8s_version # @return [::String] # The Kubernetes server version of the source cluster. # @!attribute [rw] backup_crd_versions # @return [::Google::Protobuf::Map{::String => ::String}] # A list of the Backup for GKE CRD versions found in the cluster. # @!attribute [rw] gke_version # @return [::String] # GKE version # @!attribute [rw] anthos_version # @return [::String] # Anthos version class ClusterMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class BackupCrdVersionsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # State module State # The Backup resource is in the process of being created. STATE_UNSPECIFIED = 0 # The Backup resource has been created and the associated BackupJob # Kubernetes resource has been injected into the source cluster. CREATING = 1 # The gkebackup agent in the cluster has begun executing the backup # operation. IN_PROGRESS = 2 # The backup operation has completed successfully. SUCCEEDED = 3 # The backup operation has failed. FAILED = 4 # This Backup resource (and its associated artifacts) is in the process # of being deleted. DELETING = 5 end end |