Restore(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
|
uid |
str
Output only. Server generated global unique identifier of UUID __
format.
|
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when this Restore resource was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when this Restore resource was last updated. |
description |
str
Optional. User specified descriptive string for this Restore. |
backup |
str
Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
|
cluster |
str
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.
|
restore_config |
google.cloud.gke_backup_v1.types.RestoreConfig
Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config. |
labels |
MutableMapping[str, str]
A set of custom labels supplied by user. |
state |
google.cloud.gke_backup_v1.types.Restore.State
Output only. The current state of the Restore. |
state_reason |
str
Output only. Human-readable description of why the Restore is in its current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent. |
complete_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp of when the restore operation completed. |
resources_restored_count |
int
Output only. Number of resources restored during the restore execution. |
resources_excluded_count |
int
Output only. Number of resources excluded during the restore execution. |
resources_failed_count |
int
Output only. Number of resources that failed to be restored during the restore execution. |
volumes_restored_count |
int
Output only. Number of volumes restored during the restore execution. |
etag |
str
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.
|
filter |
google.cloud.gke_backup_v1.types.Restore.Filter
Optional. Immutable. Filters resources for Restore. If
not specified, the scope of the restore will remain the same
as defined in the RestorePlan. If this is specified and
no resources are matched by the inclusion_filters or
everything is excluded by the exclusion_filters, nothing
will be restored. This filter can only be specified if the
value of
namespaced_resource_restore_mode
is set to MERGE_SKIP_ON_CONFLICT,
MERGE_REPLACE_VOLUME_ON_CONFLICT or
MERGE_REPLACE_ON_CONFLICT.
|
volume_data_restore_policy_overrides |
MutableSequence[google.cloud.gke_backup_v1.types.VolumeDataRestorePolicyOverride]
Optional. Immutable. Overrides the volume data restore policies selected in the Restore Config for override-scoped resources. |
Classes
Filter
Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)Defines the filter for Restore. This filter can be used to
further refine the resource selection of the Restore beyond the
coarse-grained scope defined in the RestorePlan.
exclusion_filters take precedence over inclusion_filters. If
a resource matches both inclusion_filters and
exclusion_filters, it will not be restored.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
State
State(value)Possible values for state of the Restore.