Enum value maps for LoggedBackup_State.
var ( LoggedBackup_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "CREATING", 2: "IN_PROGRESS", 3: "SUCCEEDED", 4: "FAILED", 5: "DELETING", } LoggedBackup_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "CREATING": 1, "IN_PROGRESS": 2, "SUCCEEDED": 3, "FAILED": 4, "DELETING": 5, } )
Enum value maps for LoggedRestore_State.
var ( LoggedRestore_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "CREATING", 2: "IN_PROGRESS", 3: "SUCCEEDED", 4: "FAILED", 5: "DELETING", } LoggedRestore_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "CREATING": 1, "IN_PROGRESS": 2, "SUCCEEDED": 3, "FAILED": 4, "DELETING": 5, } )
Enum value maps for RestoreConfig_VolumeDataRestorePolicy.
var ( RestoreConfig_VolumeDataRestorePolicy_name = map[int32]string{ 0: "VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED", 1: "RESTORE_VOLUME_DATA_FROM_BACKUP", 2: "REUSE_VOLUME_HANDLE_FROM_BACKUP", 3: "NO_VOLUME_DATA_RESTORATION", } RestoreConfig_VolumeDataRestorePolicy_value = map[string]int32{ "VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED": 0, "RESTORE_VOLUME_DATA_FROM_BACKUP": 1, "REUSE_VOLUME_HANDLE_FROM_BACKUP": 2, "NO_VOLUME_DATA_RESTORATION": 3, } )
Enum value maps for RestoreConfig_ClusterResourceConflictPolicy.
var ( RestoreConfig_ClusterResourceConflictPolicy_name = map[int32]string{ 0: "CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED", 1: "USE_EXISTING_VERSION", 2: "USE_BACKUP_VERSION", } RestoreConfig_ClusterResourceConflictPolicy_value = map[string]int32{ "CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED": 0, "USE_EXISTING_VERSION": 1, "USE_BACKUP_VERSION": 2, } )
Enum value maps for RestoreConfig_NamespacedResourceRestoreMode.
var ( RestoreConfig_NamespacedResourceRestoreMode_name = map[int32]string{ 0: "NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED", 1: "DELETE_AND_RESTORE", 2: "FAIL_ON_CONFLICT", } RestoreConfig_NamespacedResourceRestoreMode_value = map[string]int32{ "NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED": 0, "DELETE_AND_RESTORE": 1, "FAIL_ON_CONFLICT": 2, } )
Enum value maps for ChangeType.
var ( ChangeType_name = map[int32]string{ 0: "CHANGE_TYPE_UNSPECIFIED", 1: "CREATION", 2: "UPDATE", 3: "DELETION", } ChangeType_value = map[string]int32{ "CHANGE_TYPE_UNSPECIFIED": 0, "CREATION": 1, "UPDATE": 2, "DELETION": 3, } )
var File_google_cloud_gkebackup_logging_v1_logged_backup_plan_proto protoreflect.FileDescriptor
var File_google_cloud_gkebackup_logging_v1_logged_backup_proto protoreflect.FileDescriptor
var File_google_cloud_gkebackup_logging_v1_logged_common_proto protoreflect.FileDescriptor
var File_google_cloud_gkebackup_logging_v1_logged_restore_plan_proto protoreflect.FileDescriptor
var File_google_cloud_gkebackup_logging_v1_logged_restore_proto protoreflect.FileDescriptor
var File_google_cloud_gkebackup_logging_v1_logging_proto protoreflect.FileDescriptor
use case 2 A log entry when modification(creation, update, deletion) is made to a Backup
type BackupChange struct { // The full name of the Backup resource that is being modified. // Format: // projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup} Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"` // Type of the change is being made. ChangeType ChangeType `protobuf:"varint,2,opt,name=change_type,json=changeType,proto3,enum=google.cloud.gkebackup.logging.v1.ChangeType" json:"change_type,omitempty"` // Whether the change is made manually or automatically. Scheduled bool `protobuf:"varint,3,opt,name=scheduled,proto3" json:"scheduled,omitempty"` // Modification details. UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // The input Backup resource with the updated fields populated to update // the source Backup to, or the backup created automatically from retention // policy. InputBackup *LoggedBackup `protobuf:"bytes,5,opt,name=input_backup,json=inputBackup,proto3" json:"input_backup,omitempty"` // The error code and message. Error *status.Status `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"` // contains filtered or unexported fields }
func (*BackupChange) Descriptor() ([]byte, []int)
Deprecated: Use BackupChange.ProtoReflect.Descriptor instead.
func (x *BackupChange) GetBackup() string
func (x *BackupChange) GetChangeType() ChangeType
func (x *BackupChange) GetError() *status.Status
func (x *BackupChange) GetInputBackup() *LoggedBackup
func (x *BackupChange) GetScheduled() bool
func (x *BackupChange) GetUpdateMask() *fieldmaskpb.FieldMask
func (*BackupChange) ProtoMessage()
func (x *BackupChange) ProtoReflect() protoreflect.Message
func (x *BackupChange) Reset()
func (x *BackupChange) String() string
use case 1 A log entry when modification(creation, update, deletion) is made to a BackupPlan
type BackupPlanChange struct { // The full name of the old BackupPlan resource that is being modified. // Empty for creation. // Format: projects/{project}/locations/{location}/backupPlans/{backup_plan} BackupPlan string `protobuf:"bytes,1,opt,name=backup_plan,json=backupPlan,proto3" json:"backup_plan,omitempty"` // Type of the change is being made. ChangeType ChangeType `protobuf:"varint,2,opt,name=change_type,json=changeType,proto3,enum=google.cloud.gkebackup.logging.v1.ChangeType" json:"change_type,omitempty"` // Modification details. UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // The input BackupPlan resource with the updated fields populated to update // the source BackupPlan to. InputBackupPlan *LoggedBackupPlan `protobuf:"bytes,4,opt,name=input_backup_plan,json=inputBackupPlan,proto3" json:"input_backup_plan,omitempty"` // The error code and message. Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"` // contains filtered or unexported fields }
func (*BackupPlanChange) Descriptor() ([]byte, []int)
Deprecated: Use BackupPlanChange.ProtoReflect.Descriptor instead.
func (x *BackupPlanChange) GetBackupPlan() string
func (x *BackupPlanChange) GetChangeType() ChangeType
func (x *BackupPlanChange) GetError() *status.Status
func (x *BackupPlanChange) GetInputBackupPlan() *LoggedBackupPlan
func (x *BackupPlanChange) GetUpdateMask() *fieldmaskpb.FieldMask
func (*BackupPlanChange) ProtoMessage()
func (x *BackupPlanChange) ProtoReflect() protoreflect.Message
func (x *BackupPlanChange) Reset()
func (x *BackupPlanChange) String() string
The type of changes this log is about.
type ChangeType int32
const ( // Default value, not specified. ChangeType_CHANGE_TYPE_UNSPECIFIED ChangeType = 0 // The resource is created. ChangeType_CREATION ChangeType = 1 // The resource is updated. ChangeType_UPDATE ChangeType = 2 // The resource is deleted. ChangeType_DELETION ChangeType = 3 )
func (ChangeType) Descriptor() protoreflect.EnumDescriptor
func (x ChangeType) Enum() *ChangeType
func (ChangeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ChangeType.Descriptor instead.
func (x ChangeType) Number() protoreflect.EnumNumber
func (x ChangeType) String() string
func (ChangeType) Type() protoreflect.EnumType
Encryption key. This only contains the key metadata, and no key material.
type EncryptionKey struct { // Google KMS encryption key in the format: // projects/<project>/locations/<location>/keyRings/<key-ring>/cryptoKeys/<key> GcpKmsEncryptionKey string `protobuf:"bytes,1,opt,name=gcp_kms_encryption_key,json=gcpKmsEncryptionKey,proto3" json:"gcp_kms_encryption_key,omitempty"` // contains filtered or unexported fields }
func (*EncryptionKey) Descriptor() ([]byte, []int)
Deprecated: Use EncryptionKey.ProtoReflect.Descriptor instead.
func (x *EncryptionKey) GetGcpKmsEncryptionKey() string
func (*EncryptionKey) ProtoMessage()
func (x *EncryptionKey) ProtoReflect() protoreflect.Message
func (x *EncryptionKey) Reset()
func (x *EncryptionKey) String() string
Backup as stored in Platform log. It's used to log the details of a createBackup/updateBackup request, so only fields that can be taken from API calls are included here.
type LoggedBackup struct { // A set of custom labels supplied by user. Labels map[string]string `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // delete_lock_days specifies the number of days from the create_time of this // Backup before which deletion will be blocked. DeleteLockDays int32 `protobuf:"varint,2,opt,name=delete_lock_days,json=deleteLockDays,proto3" json:"delete_lock_days,omitempty"` // retain_days specifies the desired number of days from the create_time of // this Backup after which it will be automatically deleted. RetainDays int32 `protobuf:"varint,3,opt,name=retain_days,json=retainDays,proto3" json:"retain_days,omitempty"` // User specified descriptive string for this Backup. Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` // Current state of the Backup State LoggedBackup_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.gkebackup.logging.v1.LoggedBackup_State" json:"state,omitempty"` // Human-readable description of why the backup is in the current `state`. StateReason string `protobuf:"bytes,6,opt,name=state_reason,json=stateReason,proto3" json:"state_reason,omitempty"` // contains filtered or unexported fields }
func (*LoggedBackup) Descriptor() ([]byte, []int)
Deprecated: Use LoggedBackup.ProtoReflect.Descriptor instead.
func (x *LoggedBackup) GetDeleteLockDays() int32
func (x *LoggedBackup) GetDescription() string
func (x *LoggedBackup) GetLabels() map[string]string
func (x *LoggedBackup) GetRetainDays() int32
func (x *LoggedBackup) GetState() LoggedBackup_State
func (x *LoggedBackup) GetStateReason() string
func (*LoggedBackup) ProtoMessage()
func (x *LoggedBackup) ProtoReflect() protoreflect.Message
func (x *LoggedBackup) Reset()
func (x *LoggedBackup) String() string
BackupPlan as stored in Platform log. It's used to log the details of a createBackupPlan/updateBackupPlan request, so only fields that can be taken from user input are included here.
type LoggedBackupPlan struct { // User specified descriptive string for this BackupPlan. Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // GCP resource name of the source cluster for this BackupPlan. Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3" json:"cluster,omitempty"` // RetentionPolicy governs lifecycle of Backups created under this plan. RetentionPolicy *LoggedBackupPlan_RetentionPolicy `protobuf:"bytes,3,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"` // A set of custom labels supplied by user. Labels map[string]string `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // Defines scheduled Backup creation under this BackupPlan. BackupSchedule *LoggedBackupPlan_Schedule `protobuf:"bytes,5,opt,name=backup_schedule,json=backupSchedule,proto3" json:"backup_schedule,omitempty"` // A flag indicates whether the plan has been deactivated. Deactivated bool `protobuf:"varint,6,opt,name=deactivated,proto3" json:"deactivated,omitempty"` // Defines backup configuration of this BackupPlan. BackupConfig *LoggedBackupPlan_BackupConfig `protobuf:"bytes,7,opt,name=backup_config,json=backupConfig,proto3" json:"backup_config,omitempty"` // contains filtered or unexported fields }
func (*LoggedBackupPlan) Descriptor() ([]byte, []int)
Deprecated: Use LoggedBackupPlan.ProtoReflect.Descriptor instead.
func (x *LoggedBackupPlan) GetBackupConfig() *LoggedBackupPlan_BackupConfig
func (x *LoggedBackupPlan) GetBackupSchedule() *LoggedBackupPlan_Schedule
func (x *LoggedBackupPlan) GetCluster() string
func (x *LoggedBackupPlan) GetDeactivated() bool
func (x *LoggedBackupPlan) GetDescription() string
func (x *LoggedBackupPlan) GetLabels() map[string]string
func (x *LoggedBackupPlan) GetRetentionPolicy() *LoggedBackupPlan_RetentionPolicy
func (*LoggedBackupPlan) ProtoMessage()
func (x *LoggedBackupPlan) ProtoReflect() protoreflect.Message
func (x *LoggedBackupPlan) Reset()
func (x *LoggedBackupPlan) String() string
BackupConfig, an inner message type defines the configuration of creating a backup from this BackupPlan
type LoggedBackupPlan_BackupConfig struct { // Types that are assignable to BackupScope: // *LoggedBackupPlan_BackupConfig_AllNamespaces // *LoggedBackupPlan_BackupConfig_SelectedNamespaces // *LoggedBackupPlan_BackupConfig_SelectedApplications BackupScope isLoggedBackupPlan_BackupConfig_BackupScope `protobuf_oneof:"backup_scope"` // A boolean flag specifies whether volume data should be backed up IncludeVolumeData bool `protobuf:"varint,4,opt,name=include_volume_data,json=includeVolumeData,proto3" json:"include_volume_data,omitempty"` // A boolean flag specifies whether secrets should be backed up IncludeSecrets bool `protobuf:"varint,5,opt,name=include_secrets,json=includeSecrets,proto3" json:"include_secrets,omitempty"` // Custom encryption key. For preview, support GCP KMS only. // This only contains the key metadata, and no key material. EncryptionKey *EncryptionKey `protobuf:"bytes,6,opt,name=encryption_key,json=encryptionKey,proto3" json:"encryption_key,omitempty"` // contains filtered or unexported fields }
func (*LoggedBackupPlan_BackupConfig) Descriptor() ([]byte, []int)
Deprecated: Use LoggedBackupPlan_BackupConfig.ProtoReflect.Descriptor instead.
func (x *LoggedBackupPlan_BackupConfig) GetAllNamespaces() bool
func (m *LoggedBackupPlan_BackupConfig) GetBackupScope() isLoggedBackupPlan_BackupConfig_BackupScope
func (x *LoggedBackupPlan_BackupConfig) GetEncryptionKey() *EncryptionKey
func (x *LoggedBackupPlan_BackupConfig) GetIncludeSecrets() bool
func (x *LoggedBackupPlan_BackupConfig) GetIncludeVolumeData() bool
func (x *LoggedBackupPlan_BackupConfig) GetSelectedApplications() *NamespacedNames
func (x *LoggedBackupPlan_BackupConfig) GetSelectedNamespaces() *Namespaces
func (*LoggedBackupPlan_BackupConfig) ProtoMessage()
func (x *LoggedBackupPlan_BackupConfig) ProtoReflect() protoreflect.Message
func (x *LoggedBackupPlan_BackupConfig) Reset()
func (x *LoggedBackupPlan_BackupConfig) String() string
type LoggedBackupPlan_BackupConfig_AllNamespaces struct { // If set to true, backup whole cluster AllNamespaces bool `protobuf:"varint,1,opt,name=all_namespaces,json=allNamespaces,proto3,oneof"` }
type LoggedBackupPlan_BackupConfig_SelectedApplications struct { // If set, backup the list of applications SelectedApplications *NamespacedNames `protobuf:"bytes,3,opt,name=selected_applications,json=selectedApplications,proto3,oneof"` }
type LoggedBackupPlan_BackupConfig_SelectedNamespaces struct { // If set, backup the list of namespaces SelectedNamespaces *Namespaces `protobuf:"bytes,2,opt,name=selected_namespaces,json=selectedNamespaces,proto3,oneof"` }
RentionPolicy is an inner message type to define: 1. When to automatically delete Backups created under this BackupPlan 2. A plan level minimum Backup retain days which blocks deletion 3. Lock to disallow any policy updates
type LoggedBackupPlan_RetentionPolicy struct { // Number of days during which deletion of a Backup created under this // BackupPlan will be blocked. BackupDeleteLockDays int32 `protobuf:"varint,1,opt,name=backup_delete_lock_days,json=backupDeleteLockDays,proto3" json:"backup_delete_lock_days,omitempty"` // Number of days after which the service will delete a Backup. // If specified, a Backup created under this BackupPlan will be // automatically deleted after its age reaches create_time + // backup_retain_days. BackupRetainDays int32 `protobuf:"varint,2,opt,name=backup_retain_days,json=backupRetainDays,proto3" json:"backup_retain_days,omitempty"` // A flag denotes that the retention policy of this BackupPlan is locked. // If set to True, no further update is allowed on this policy, including // the 'locked' field itself. // Default to False. Locked bool `protobuf:"varint,3,opt,name=locked,proto3" json:"locked,omitempty"` // contains filtered or unexported fields }
func (*LoggedBackupPlan_RetentionPolicy) Descriptor() ([]byte, []int)
Deprecated: Use LoggedBackupPlan_RetentionPolicy.ProtoReflect.Descriptor instead.
func (x *LoggedBackupPlan_RetentionPolicy) GetBackupDeleteLockDays() int32
func (x *LoggedBackupPlan_RetentionPolicy) GetBackupRetainDays() int32
func (x *LoggedBackupPlan_RetentionPolicy) GetLocked() bool
func (*LoggedBackupPlan_RetentionPolicy) ProtoMessage()
func (x *LoggedBackupPlan_RetentionPolicy) ProtoReflect() protoreflect.Message
func (x *LoggedBackupPlan_RetentionPolicy) Reset()
func (x *LoggedBackupPlan_RetentionPolicy) String() string
Schedule, an inner message type defines a cron schedule.
type LoggedBackupPlan_Schedule struct { // A cron style string schedule on which an operation will be executed. CronSchedule string `protobuf:"bytes,1,opt,name=cron_schedule,json=cronSchedule,proto3" json:"cron_schedule,omitempty"` // A flag to toggle scheduled operation. Paused bool `protobuf:"varint,2,opt,name=paused,proto3" json:"paused,omitempty"` // contains filtered or unexported fields }
func (*LoggedBackupPlan_Schedule) Descriptor() ([]byte, []int)
Deprecated: Use LoggedBackupPlan_Schedule.ProtoReflect.Descriptor instead.
func (x *LoggedBackupPlan_Schedule) GetCronSchedule() string
func (x *LoggedBackupPlan_Schedule) GetPaused() bool
func (*LoggedBackupPlan_Schedule) ProtoMessage()
func (x *LoggedBackupPlan_Schedule) ProtoReflect() protoreflect.Message
func (x *LoggedBackupPlan_Schedule) Reset()
func (x *LoggedBackupPlan_Schedule) String() string
State
type LoggedBackup_State int32
const ( // The Backup resource is in the process of being created. LoggedBackup_STATE_UNSPECIFIED LoggedBackup_State = 0 // The Backup resource has been created and the associated BackupJob // Kubernetes resource has been injected into the source cluster. LoggedBackup_CREATING LoggedBackup_State = 1 // The gkebackup agent in the cluster has begun executing the backup // operation. LoggedBackup_IN_PROGRESS LoggedBackup_State = 2 // The backup operation has completed successfully. LoggedBackup_SUCCEEDED LoggedBackup_State = 3 // The backup operation has failed. LoggedBackup_FAILED LoggedBackup_State = 4 // This Backup resource (and its associated artifacts) is in the process // of being deleted. LoggedBackup_DELETING LoggedBackup_State = 5 )
func (LoggedBackup_State) Descriptor() protoreflect.EnumDescriptor
func (x LoggedBackup_State) Enum() *LoggedBackup_State
func (LoggedBackup_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use LoggedBackup_State.Descriptor instead.
func (x LoggedBackup_State) Number() protoreflect.EnumNumber
func (x LoggedBackup_State) String() string
func (LoggedBackup_State) Type() protoreflect.EnumType
Restore as stored in Platform log. It's used to log the update details of a updateRestore request, so only mutable and non-output_only fields are included here..
type LoggedRestore struct { // Full name of the Backup resource this Restore resource used to restore // from. Format: projects/*/locations/*/backupPlans/*/backups/*. Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"` // GCP Labels. Labels map[string]string `protobuf:"bytes,2,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // User specified descriptive string for this Restore. Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` // The current state of the Restore. State LoggedRestore_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.gkebackup.logging.v1.LoggedRestore_State" json:"state,omitempty"` // Human-readable description of why the Restore is in its current state. StateReason string `protobuf:"bytes,5,opt,name=state_reason,json=stateReason,proto3" json:"state_reason,omitempty"` // contains filtered or unexported fields }
func (*LoggedRestore) Descriptor() ([]byte, []int)
Deprecated: Use LoggedRestore.ProtoReflect.Descriptor instead.
func (x *LoggedRestore) GetBackup() string
func (x *LoggedRestore) GetDescription() string
func (x *LoggedRestore) GetLabels() map[string]string
func (x *LoggedRestore) GetState() LoggedRestore_State
func (x *LoggedRestore) GetStateReason() string
func (*LoggedRestore) ProtoMessage()
func (x *LoggedRestore) ProtoReflect() protoreflect.Message
func (x *LoggedRestore) Reset()
func (x *LoggedRestore) String() string
RestorePlan as stored in Platform log. It's used to log the details of a createRestorePlan/updateRestorePlan request, so only fields that can be taken from user input are included here.
type LoggedRestorePlan struct { // User specified descriptive string for this RestorePlan. Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // The BackupPlan from which Backups may be used as the source // for Restores created via this RestorePlan. // Format: projects/*/locations/*/backupPlans/*. BackupPlan string `protobuf:"bytes,2,opt,name=backup_plan,json=backupPlan,proto3" json:"backup_plan,omitempty"` // The target cluster into which Restores created via this RestorePlan // will restore data. NOTE: the cluster's region must be the same as the // RestorePlan. // Possible formats: // 1. projects/*/locations/*/clusters/* // 2. projects/*/zones/*/clusters/* Cluster string `protobuf:"bytes,3,opt,name=cluster,proto3" json:"cluster,omitempty"` // Configuration of Restores created via this RestorePlan. RestoreConfig *RestoreConfig `protobuf:"bytes,4,opt,name=restore_config,json=restoreConfig,proto3" json:"restore_config,omitempty"` // A set of custom labels supplied by user. Labels map[string]string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // contains filtered or unexported fields }
func (*LoggedRestorePlan) Descriptor() ([]byte, []int)
Deprecated: Use LoggedRestorePlan.ProtoReflect.Descriptor instead.
func (x *LoggedRestorePlan) GetBackupPlan() string
func (x *LoggedRestorePlan) GetCluster() string
func (x *LoggedRestorePlan) GetDescription() string
func (x *LoggedRestorePlan) GetLabels() map[string]string
func (x *LoggedRestorePlan) GetRestoreConfig() *RestoreConfig
func (*LoggedRestorePlan) ProtoMessage()
func (x *LoggedRestorePlan) ProtoReflect() protoreflect.Message
func (x *LoggedRestorePlan) Reset()
func (x *LoggedRestorePlan) String() string
Possible values for state of the Restore.
type LoggedRestore_State int32
const ( // The Restore resource is in the process of being created. LoggedRestore_STATE_UNSPECIFIED LoggedRestore_State = 0 // The Restore resource has been created and the associated RestoreJob // Kubernetes resource has been injected into target cluster. LoggedRestore_CREATING LoggedRestore_State = 1 // The gkebackup agent in the cluster has begun executing the restore // operation. LoggedRestore_IN_PROGRESS LoggedRestore_State = 2 // The restore operation has completed successfully. Restored workloads may // not yet be operational. LoggedRestore_SUCCEEDED LoggedRestore_State = 3 // The restore operation has failed. LoggedRestore_FAILED LoggedRestore_State = 4 // This Restore resource is in the process of being deleted. LoggedRestore_DELETING LoggedRestore_State = 5 )
func (LoggedRestore_State) Descriptor() protoreflect.EnumDescriptor
func (x LoggedRestore_State) Enum() *LoggedRestore_State
func (LoggedRestore_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use LoggedRestore_State.Descriptor instead.
func (x LoggedRestore_State) Number() protoreflect.EnumNumber
func (x LoggedRestore_State) String() string
func (LoggedRestore_State) Type() protoreflect.EnumType
NamespacedName
type NamespacedName struct { // the namespace of the resource in Kubernetes Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` // the name of the resource in Kubernetes Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*NamespacedName) Descriptor() ([]byte, []int)
Deprecated: Use NamespacedName.ProtoReflect.Descriptor instead.
func (x *NamespacedName) GetName() string
func (x *NamespacedName) GetNamespace() string
func (*NamespacedName) ProtoMessage()
func (x *NamespacedName) ProtoReflect() protoreflect.Message
func (x *NamespacedName) Reset()
func (x *NamespacedName) String() string
NamespacedNames
type NamespacedNames struct { // a list of namespaced names in Kubernetes NamespacedNames []*NamespacedName `protobuf:"bytes,1,rep,name=namespaced_names,json=namespacedNames,proto3" json:"namespaced_names,omitempty"` // contains filtered or unexported fields }
func (*NamespacedNames) Descriptor() ([]byte, []int)
Deprecated: Use NamespacedNames.ProtoReflect.Descriptor instead.
func (x *NamespacedNames) GetNamespacedNames() []*NamespacedName
func (*NamespacedNames) ProtoMessage()
func (x *NamespacedNames) ProtoReflect() protoreflect.Message
func (x *NamespacedNames) Reset()
func (x *NamespacedNames) String() string
Namespaces, list of namespaces
type Namespaces struct { // namespaces Namespaces []string `protobuf:"bytes,1,rep,name=namespaces,proto3" json:"namespaces,omitempty"` // contains filtered or unexported fields }
func (*Namespaces) Descriptor() ([]byte, []int)
Deprecated: Use Namespaces.ProtoReflect.Descriptor instead.
func (x *Namespaces) GetNamespaces() []string
func (*Namespaces) ProtoMessage()
func (x *Namespaces) ProtoReflect() protoreflect.Message
func (x *Namespaces) Reset()
func (x *Namespaces) String() string
use case 4 A log entry when modification(creation, update, deletion) is made to a restore.
type RestoreChange struct { // The full name of the Restore resource that is being modified. // Empty for creation. // Format: projects/*/locations/*/restorePlans/*/restores/* Restore string `protobuf:"bytes,1,opt,name=restore,proto3" json:"restore,omitempty"` // Type of the change is being made. ChangeType ChangeType `protobuf:"varint,2,opt,name=change_type,json=changeType,proto3,enum=google.cloud.gkebackup.logging.v1.ChangeType" json:"change_type,omitempty"` // Modification details. UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // The input Restore resource with the updated fields populated to update // the source Restore to. InputRestore *LoggedRestore `protobuf:"bytes,4,opt,name=input_restore,json=inputRestore,proto3" json:"input_restore,omitempty"` // The error code and message. Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"` // contains filtered or unexported fields }
func (*RestoreChange) Descriptor() ([]byte, []int)
Deprecated: Use RestoreChange.ProtoReflect.Descriptor instead.
func (x *RestoreChange) GetChangeType() ChangeType
func (x *RestoreChange) GetError() *status.Status
func (x *RestoreChange) GetInputRestore() *LoggedRestore
func (x *RestoreChange) GetRestore() string
func (x *RestoreChange) GetUpdateMask() *fieldmaskpb.FieldMask
func (*RestoreChange) ProtoMessage()
func (x *RestoreChange) ProtoReflect() protoreflect.Message
func (x *RestoreChange) Reset()
func (x *RestoreChange) String() string
Configuration of a restore.
type RestoreConfig struct { // Specifies the mechanism to be used to restore volume data. // Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as // NO_VOLUME_DATA_RESTORATION). VolumeDataRestorePolicy RestoreConfig_VolumeDataRestorePolicy `protobuf:"varint,1,opt,name=volume_data_restore_policy,json=volumeDataRestorePolicy,proto3,enum=google.cloud.gkebackup.logging.v1.RestoreConfig_VolumeDataRestorePolicy" json:"volume_data_restore_policy,omitempty"` // Defines the behavior for handling the situation where cluster-scoped // resources being restored already exist in the target cluster. This MUST be // set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if // cluster_resource_restore_scope is not empty. ClusterResourceConflictPolicy RestoreConfig_ClusterResourceConflictPolicy `protobuf:"varint,2,opt,name=cluster_resource_conflict_policy,json=clusterResourceConflictPolicy,proto3,enum=google.cloud.gkebackup.logging.v1.RestoreConfig_ClusterResourceConflictPolicy" json:"cluster_resource_conflict_policy,omitempty"` // Defines the behavior for handling the situation where sets of namespaced // resources being restored already exist in the target cluster. This MUST be // set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED if // any namespaced restoration is configured via // namespaced_resource_restore_scope . NamespacedResourceRestoreMode RestoreConfig_NamespacedResourceRestoreMode `protobuf:"varint,3,opt,name=namespaced_resource_restore_mode,json=namespacedResourceRestoreMode,proto3,enum=google.cloud.gkebackup.logging.v1.RestoreConfig_NamespacedResourceRestoreMode" json:"namespaced_resource_restore_mode,omitempty"` // Identifies the cluster-scoped resources to restore from the Backup. // Not specifying it means NO cluster resource will be restored. ClusterResourceRestoreScope *RestoreConfig_ClusterResourceRestoreScope `protobuf:"bytes,4,opt,name=cluster_resource_restore_scope,json=clusterResourceRestoreScope,proto3" json:"cluster_resource_restore_scope,omitempty"` // Specifies the namespaced resources to restore from the Backup. // Only one of the entries may be specified. If not specified, NO namespaced // resources will be restored. // // Types that are assignable to NamespacedResourceRestoreScope: // *RestoreConfig_AllNamespaces // *RestoreConfig_SelectedNamespaces // *RestoreConfig_SelectedApplications NamespacedResourceRestoreScope isRestoreConfig_NamespacedResourceRestoreScope `protobuf_oneof:"namespaced_resource_restore_scope"` // A list of transformation rules to be applied against Kubernetes resources // as they are selected for restoration from a Backup. Rules are executed in // order defined - this order matters, as changes made by a rule may impact // the filtering logic of subsequent rules. An empty list means no // substitution will occur. SubstitutionRules []*RestoreConfig_SubstitutionRule `protobuf:"bytes,8,rep,name=substitution_rules,json=substitutionRules,proto3" json:"substitution_rules,omitempty"` // contains filtered or unexported fields }
func (*RestoreConfig) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig.ProtoReflect.Descriptor instead.
func (x *RestoreConfig) GetAllNamespaces() bool
func (x *RestoreConfig) GetClusterResourceConflictPolicy() RestoreConfig_ClusterResourceConflictPolicy
func (x *RestoreConfig) GetClusterResourceRestoreScope() *RestoreConfig_ClusterResourceRestoreScope
func (x *RestoreConfig) GetNamespacedResourceRestoreMode() RestoreConfig_NamespacedResourceRestoreMode
func (m *RestoreConfig) GetNamespacedResourceRestoreScope() isRestoreConfig_NamespacedResourceRestoreScope
func (x *RestoreConfig) GetSelectedApplications() *NamespacedNames
func (x *RestoreConfig) GetSelectedNamespaces() *Namespaces
func (x *RestoreConfig) GetSubstitutionRules() []*RestoreConfig_SubstitutionRule
func (x *RestoreConfig) GetVolumeDataRestorePolicy() RestoreConfig_VolumeDataRestorePolicy
func (*RestoreConfig) ProtoMessage()
func (x *RestoreConfig) ProtoReflect() protoreflect.Message
func (x *RestoreConfig) Reset()
func (x *RestoreConfig) String() string
type RestoreConfig_AllNamespaces struct { // Restore all namespaced resources in the Backup if set to "True". // Specifying this field to "False" is an error. AllNamespaces bool `protobuf:"varint,5,opt,name=all_namespaces,json=allNamespaces,proto3,oneof"` }
Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster.
type RestoreConfig_ClusterResourceConflictPolicy int32
const ( // Unspecified. Only allowed if no cluster-scoped resources will be // restored. RestoreConfig_CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED RestoreConfig_ClusterResourceConflictPolicy = 0 // Do not attempt to restore the conflicting resource. RestoreConfig_USE_EXISTING_VERSION RestoreConfig_ClusterResourceConflictPolicy = 1 // Delete the existing version before re-creating it from the Backup. // Note that this is a dangerous option which could cause unintentional // data loss if used inappropriately - for example, deleting a CRD will // cause Kubernetes to delete all CRs of that type. RestoreConfig_USE_BACKUP_VERSION RestoreConfig_ClusterResourceConflictPolicy = 2 )
func (RestoreConfig_ClusterResourceConflictPolicy) Descriptor() protoreflect.EnumDescriptor
func (x RestoreConfig_ClusterResourceConflictPolicy) Enum() *RestoreConfig_ClusterResourceConflictPolicy
func (RestoreConfig_ClusterResourceConflictPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_ClusterResourceConflictPolicy.Descriptor instead.
func (x RestoreConfig_ClusterResourceConflictPolicy) Number() protoreflect.EnumNumber
func (x RestoreConfig_ClusterResourceConflictPolicy) String() string
func (RestoreConfig_ClusterResourceConflictPolicy) Type() protoreflect.EnumType
Identifies the cluster-scoped resources to restore from the Backup.
type RestoreConfig_ClusterResourceRestoreScope struct { // A list of "types" of cluster-scoped resources to be restored from the // Backup. An empty list means that NO cluster-scoped resources will be // restored. Note that Namespaces and PersistentVolume restoration is // handled separately and is not governed by this field. SelectedGroupKinds []*RestoreConfig_GroupKind `protobuf:"bytes,1,rep,name=selected_group_kinds,json=selectedGroupKinds,proto3" json:"selected_group_kinds,omitempty"` // contains filtered or unexported fields }
func (*RestoreConfig_ClusterResourceRestoreScope) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_ClusterResourceRestoreScope.ProtoReflect.Descriptor instead.
func (x *RestoreConfig_ClusterResourceRestoreScope) GetSelectedGroupKinds() []*RestoreConfig_GroupKind
func (*RestoreConfig_ClusterResourceRestoreScope) ProtoMessage()
func (x *RestoreConfig_ClusterResourceRestoreScope) ProtoReflect() protoreflect.Message
func (x *RestoreConfig_ClusterResourceRestoreScope) Reset()
func (x *RestoreConfig_ClusterResourceRestoreScope) String() string
This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore.
type RestoreConfig_GroupKind struct { // API group string of a Kubernetes resource, e.g. // "apiextensions.k8s.io", "storage.k8s.io", etc. // Note: use empty string for core API group ResourceGroup string `protobuf:"bytes,1,opt,name=resource_group,json=resourceGroup,proto3" json:"resource_group,omitempty"` // Kind of a Kubernetes resource, e.g. // "CustomResourceDefinition", "StorageClass", etc. ResourceKind string `protobuf:"bytes,2,opt,name=resource_kind,json=resourceKind,proto3" json:"resource_kind,omitempty"` // contains filtered or unexported fields }
func (*RestoreConfig_GroupKind) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_GroupKind.ProtoReflect.Descriptor instead.
func (x *RestoreConfig_GroupKind) GetResourceGroup() string
func (x *RestoreConfig_GroupKind) GetResourceKind() string
func (*RestoreConfig_GroupKind) ProtoMessage()
func (x *RestoreConfig_GroupKind) ProtoReflect() protoreflect.Message
func (x *RestoreConfig_GroupKind) Reset()
func (x *RestoreConfig_GroupKind) String() string
Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster.
type RestoreConfig_NamespacedResourceRestoreMode int32
const ( // Unspecified. Only allowed if no namespaced resources will be restored. RestoreConfig_NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED RestoreConfig_NamespacedResourceRestoreMode = 0 // When conflicting top-level resources (either Namespaces or // ProtectedApplications, depending upon the scope) are encountered, this // will first trigger a delete of the conflicting resource AND ALL OF ITS // REFERENCED RESOURCES (e.g., all resources in the Namespace or all // resources referenced by the ProtectedApplication) before restoring the // resources from the Backup. This mode should only be used when you are // intending to revert some portion of a cluster to an earlier state. RestoreConfig_DELETE_AND_RESTORE RestoreConfig_NamespacedResourceRestoreMode = 1 // If conflicting top-level resources (either Namespaces or // ProtectedApplications, depending upon the scope) are encountered at the // beginning of a restore process, the Restore will fail. If a conflict // occurs during the restore process itself (e.g., because an out of band // process creates conflicting resources), a conflict will be reported. RestoreConfig_FAIL_ON_CONFLICT RestoreConfig_NamespacedResourceRestoreMode = 2 )
func (RestoreConfig_NamespacedResourceRestoreMode) Descriptor() protoreflect.EnumDescriptor
func (x RestoreConfig_NamespacedResourceRestoreMode) Enum() *RestoreConfig_NamespacedResourceRestoreMode
func (RestoreConfig_NamespacedResourceRestoreMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_NamespacedResourceRestoreMode.Descriptor instead.
func (x RestoreConfig_NamespacedResourceRestoreMode) Number() protoreflect.EnumNumber
func (x RestoreConfig_NamespacedResourceRestoreMode) String() string
func (RestoreConfig_NamespacedResourceRestoreMode) Type() protoreflect.EnumType
type RestoreConfig_SelectedApplications struct { // A list of selected ProtectedApplications to restore. The listed // ProtectedApplications and all the resources to which they refer will be // restored. SelectedApplications *NamespacedNames `protobuf:"bytes,7,opt,name=selected_applications,json=selectedApplications,proto3,oneof"` }
type RestoreConfig_SelectedNamespaces struct { // A list of selected Namespaces to restore from the Backup. The listed // Namespaces and all resources contained in them will be restored. SelectedNamespaces *Namespaces `protobuf:"bytes,6,opt,name=selected_namespaces,json=selectedNamespaces,proto3,oneof"` }
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.
type RestoreConfig_SubstitutionRule struct { // (Filtering parameter) Any resource subject to substitution must be // contained within one of the listed Kubernetes Namespace in the Backup. // If this field is not provided, no namespace filtering will be performed // (all resources in all Namespaces, including all cluster-scoped resources, // will be candidates for substitution). // To mix cluster-scoped and namespaced resources in the same rule, use an // empty string ("") as one of the target namespaces. TargetNamespaces []string `protobuf:"bytes,1,rep,name=target_namespaces,json=targetNamespaces,proto3" json:"target_namespaces,omitempty"` // (Filtering parameter) Any resource subject to substitution must belong to // one of the listed "types". // If this field is not provided, no type filtering will be performed (all // resources of all types matching previous filtering parameters will be // candidates for substitution). TargetGroupKinds []*RestoreConfig_GroupKind `protobuf:"bytes,2,rep,name=target_group_kinds,json=targetGroupKinds,proto3" json:"target_group_kinds,omitempty"` // This is a [JSONPath] // ([https://kubernetes.io/docs/reference/kubectl/jsonpath/) // expression that matches specific fields of candidate // resources and it operates as both a filtering parameter (resources that // are not matched with this expression will not be candidates for // substitution) as well as a field identifier (identifies exactly which // fields out of the candidate resources will be modified). TargetJsonPath string `protobuf:"bytes,3,opt,name=target_json_path,json=targetJsonPath,proto3" json:"target_json_path,omitempty"` // (Filtering parameter) This is a [regular expression] // (https://en.wikipedia.org/wiki/Regular_expression) // that is compared against the fields matched by the target_json_path // expression (and must also have passed the previous filters). // Substitution will not be performed against fields whose // value does not match this expression. If this field is NOT specified, // then ALL fields matched by the target_json_path expression will undergo // substitution. Note that an empty (e.g., "", rather than unspecified) // value for for this field will only match empty fields. OriginalValuePattern string `protobuf:"bytes,4,opt,name=original_value_pattern,json=originalValuePattern,proto3" json:"original_value_pattern,omitempty"` // This is the new value to set for any fields that pass the filtering and // selection criteria. To remove a value from a Kubernetes resource, either // leave this field unspecified, or set it to the empty string (""). NewValue string `protobuf:"bytes,5,opt,name=new_value,json=newValue,proto3" json:"new_value,omitempty"` // contains filtered or unexported fields }
func (*RestoreConfig_SubstitutionRule) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_SubstitutionRule.ProtoReflect.Descriptor instead.
func (x *RestoreConfig_SubstitutionRule) GetNewValue() string
func (x *RestoreConfig_SubstitutionRule) GetOriginalValuePattern() string
func (x *RestoreConfig_SubstitutionRule) GetTargetGroupKinds() []*RestoreConfig_GroupKind
func (x *RestoreConfig_SubstitutionRule) GetTargetJsonPath() string
func (x *RestoreConfig_SubstitutionRule) GetTargetNamespaces() []string
func (*RestoreConfig_SubstitutionRule) ProtoMessage()
func (x *RestoreConfig_SubstitutionRule) ProtoReflect() protoreflect.Message
func (x *RestoreConfig_SubstitutionRule) Reset()
func (x *RestoreConfig_SubstitutionRule) String() string
Defines how volume data should be restored
type RestoreConfig_VolumeDataRestorePolicy int32
const ( // unspecified, default value RestoreConfig_VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED RestoreConfig_VolumeDataRestorePolicy = 0 // For each PVC to be restored, will create a new underlying volume (and PV) // from the corresponding VolumeBackup contained within the Backup. RestoreConfig_RESTORE_VOLUME_DATA_FROM_BACKUP RestoreConfig_VolumeDataRestorePolicy = 1 // For each PVC to be restored, attempt to reuse the original PV contained // in the Backup (with its original underlying volume). Note that option // is likely only usable when restoring a workload to its original cluster. RestoreConfig_REUSE_VOLUME_HANDLE_FROM_BACKUP RestoreConfig_VolumeDataRestorePolicy = 2 // For each PVC to be restored, PVCs will be created without any particular // action to restore data. In this case, the normal Kubernetes provisioning // logic would kick in, and this would likely result in either dynamically // provisioning blank PVs or binding to statically provisioned PVs. RestoreConfig_NO_VOLUME_DATA_RESTORATION RestoreConfig_VolumeDataRestorePolicy = 3 )
func (RestoreConfig_VolumeDataRestorePolicy) Descriptor() protoreflect.EnumDescriptor
func (x RestoreConfig_VolumeDataRestorePolicy) Enum() *RestoreConfig_VolumeDataRestorePolicy
func (RestoreConfig_VolumeDataRestorePolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_VolumeDataRestorePolicy.Descriptor instead.
func (x RestoreConfig_VolumeDataRestorePolicy) Number() protoreflect.EnumNumber
func (x RestoreConfig_VolumeDataRestorePolicy) String() string
func (RestoreConfig_VolumeDataRestorePolicy) Type() protoreflect.EnumType
use case 3 A log entry when modification(creation, update, deletion) is made to a restorePlan.
type RestorePlanChange struct { // The full name of the RestorePlan resource that is being modified. // Empty for creation. // Format: projects/*/locations/*/restorePlans/* RestorePlan string `protobuf:"bytes,1,opt,name=restore_plan,json=restorePlan,proto3" json:"restore_plan,omitempty"` // Type of the change is being made. ChangeType ChangeType `protobuf:"varint,2,opt,name=change_type,json=changeType,proto3,enum=google.cloud.gkebackup.logging.v1.ChangeType" json:"change_type,omitempty"` // Modification details. UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // The input RestorePlan resource with the updated fields populated to update // the source RestorePlan to. InputRestorePlan *LoggedRestorePlan `protobuf:"bytes,4,opt,name=input_restore_plan,json=inputRestorePlan,proto3" json:"input_restore_plan,omitempty"` // The error code and message. Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"` // contains filtered or unexported fields }
func (*RestorePlanChange) Descriptor() ([]byte, []int)
Deprecated: Use RestorePlanChange.ProtoReflect.Descriptor instead.
func (x *RestorePlanChange) GetChangeType() ChangeType
func (x *RestorePlanChange) GetError() *status.Status
func (x *RestorePlanChange) GetInputRestorePlan() *LoggedRestorePlan
func (x *RestorePlanChange) GetRestorePlan() string
func (x *RestorePlanChange) GetUpdateMask() *fieldmaskpb.FieldMask
func (*RestorePlanChange) ProtoMessage()
func (x *RestorePlanChange) ProtoReflect() protoreflect.Message
func (x *RestorePlanChange) Reset()
func (x *RestorePlanChange) String() string