Documentation ¶
Overview ¶
Package gkebackupdata provides Backup for GKE type definitions for CloudEvent data payloads.
Supported CloudEvent Types ¶
- google.cloud.gkebackup.backupPlan.v1.created
- google.cloud.gkebackup.backupPlan.v1.updated
- google.cloud.gkebackup.backupPlan.v1.deleted
- google.cloud.gkebackup.backup.v1.created
- google.cloud.gkebackup.backup.v1.updated
- google.cloud.gkebackup.backup.v1.deleted
- google.cloud.gkebackup.restorePlan.v1.created
- google.cloud.gkebackup.restorePlan.v1.updated
- google.cloud.gkebackup.restorePlan.v1.deleted
- google.cloud.gkebackup.restore.v1.created
- google.cloud.gkebackup.restore.v1.updated
- google.cloud.gkebackup.restore.v1.deleted
Index ¶
- Variables
- type Backup
- func (*Backup) Descriptor() ([]byte, []int)deprecated
- func (x *Backup) GetAllNamespaces() bool
- func (m *Backup) GetBackupScope() isBackup_BackupScope
- func (x *Backup) GetClusterMetadata() *Backup_ClusterMetadata
- func (x *Backup) GetCompleteTime() *timestamppb.Timestamp
- func (x *Backup) GetConfigBackupSizeBytes() int64
- func (x *Backup) GetContainsSecrets() bool
- func (x *Backup) GetContainsVolumeData() bool
- func (x *Backup) GetCreateTime() *timestamppb.Timestamp
- func (x *Backup) GetDeleteLockDays() int32
- func (x *Backup) GetDeleteLockExpireTime() *timestamppb.Timestamp
- func (x *Backup) GetDescription() string
- func (x *Backup) GetEncryptionKey() *EncryptionKey
- func (x *Backup) GetEtag() string
- func (x *Backup) GetLabels() map[string]string
- func (x *Backup) GetManual() bool
- func (x *Backup) GetName() string
- func (x *Backup) GetPodCount() int32
- func (x *Backup) GetResourceCount() int32
- func (x *Backup) GetRetainDays() int32
- func (x *Backup) GetRetainExpireTime() *timestamppb.Timestamp
- func (x *Backup) GetSelectedApplications() *NamespacedNames
- func (x *Backup) GetSelectedNamespaces() *Namespaces
- func (x *Backup) GetSizeBytes() int64
- func (x *Backup) GetState() Backup_State
- func (x *Backup) GetStateReason() string
- func (x *Backup) GetUid() string
- func (x *Backup) GetUpdateTime() *timestamppb.Timestamp
- func (x *Backup) GetVolumeCount() int32
- func (*Backup) ProtoMessage()
- func (x *Backup) ProtoReflect() protoreflect.Message
- func (x *Backup) Reset()
- func (x *Backup) String() string
- type BackupEventData
- type BackupPlan
- func (*BackupPlan) Descriptor() ([]byte, []int)deprecated
- func (x *BackupPlan) GetBackupConfig() *BackupPlan_BackupConfig
- func (x *BackupPlan) GetBackupSchedule() *BackupPlan_Schedule
- func (x *BackupPlan) GetCluster() string
- func (x *BackupPlan) GetCreateTime() *timestamppb.Timestamp
- func (x *BackupPlan) GetDeactivated() bool
- func (x *BackupPlan) GetDescription() string
- func (x *BackupPlan) GetEtag() string
- func (x *BackupPlan) GetLabels() map[string]string
- func (x *BackupPlan) GetName() string
- func (x *BackupPlan) GetProtectedPodCount() int32
- func (x *BackupPlan) GetRetentionPolicy() *BackupPlan_RetentionPolicy
- func (x *BackupPlan) GetUid() string
- func (x *BackupPlan) GetUpdateTime() *timestamppb.Timestamp
- func (*BackupPlan) ProtoMessage()
- func (x *BackupPlan) ProtoReflect() protoreflect.Message
- func (x *BackupPlan) Reset()
- func (x *BackupPlan) String() string
- type BackupPlanEventData
- func (*BackupPlanEventData) Descriptor() ([]byte, []int)deprecated
- func (x *BackupPlanEventData) GetPayload() *BackupPlan
- func (*BackupPlanEventData) ProtoMessage()
- func (x *BackupPlanEventData) ProtoReflect() protoreflect.Message
- func (x *BackupPlanEventData) Reset()
- func (x *BackupPlanEventData) String() string
- type BackupPlan_BackupConfig
- func (*BackupPlan_BackupConfig) Descriptor() ([]byte, []int)deprecated
- func (x *BackupPlan_BackupConfig) GetAllNamespaces() bool
- func (m *BackupPlan_BackupConfig) GetBackupScope() isBackupPlan_BackupConfig_BackupScope
- func (x *BackupPlan_BackupConfig) GetEncryptionKey() *EncryptionKey
- func (x *BackupPlan_BackupConfig) GetIncludeSecrets() bool
- func (x *BackupPlan_BackupConfig) GetIncludeVolumeData() bool
- func (x *BackupPlan_BackupConfig) GetSelectedApplications() *NamespacedNames
- func (x *BackupPlan_BackupConfig) GetSelectedNamespaces() *Namespaces
- func (*BackupPlan_BackupConfig) ProtoMessage()
- func (x *BackupPlan_BackupConfig) ProtoReflect() protoreflect.Message
- func (x *BackupPlan_BackupConfig) Reset()
- func (x *BackupPlan_BackupConfig) String() string
- type BackupPlan_BackupConfig_AllNamespaces
- type BackupPlan_BackupConfig_SelectedApplications
- type BackupPlan_BackupConfig_SelectedNamespaces
- type BackupPlan_RetentionPolicy
- func (*BackupPlan_RetentionPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *BackupPlan_RetentionPolicy) GetBackupDeleteLockDays() int32
- func (x *BackupPlan_RetentionPolicy) GetBackupRetainDays() int32
- func (x *BackupPlan_RetentionPolicy) GetLocked() bool
- func (*BackupPlan_RetentionPolicy) ProtoMessage()
- func (x *BackupPlan_RetentionPolicy) ProtoReflect() protoreflect.Message
- func (x *BackupPlan_RetentionPolicy) Reset()
- func (x *BackupPlan_RetentionPolicy) String() string
- type BackupPlan_Schedule
- func (*BackupPlan_Schedule) Descriptor() ([]byte, []int)deprecated
- func (x *BackupPlan_Schedule) GetCronSchedule() string
- func (x *BackupPlan_Schedule) GetPaused() bool
- func (*BackupPlan_Schedule) ProtoMessage()
- func (x *BackupPlan_Schedule) ProtoReflect() protoreflect.Message
- func (x *BackupPlan_Schedule) Reset()
- func (x *BackupPlan_Schedule) String() string
- type Backup_AllNamespaces
- type Backup_ClusterMetadata
- func (*Backup_ClusterMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *Backup_ClusterMetadata) GetAnthosVersion() string
- func (x *Backup_ClusterMetadata) GetBackupCrdVersions() map[string]string
- func (x *Backup_ClusterMetadata) GetCluster() string
- func (x *Backup_ClusterMetadata) GetGkeVersion() string
- func (x *Backup_ClusterMetadata) GetK8SVersion() string
- func (m *Backup_ClusterMetadata) GetPlatformVersion() isBackup_ClusterMetadata_PlatformVersion
- func (*Backup_ClusterMetadata) ProtoMessage()
- func (x *Backup_ClusterMetadata) ProtoReflect() protoreflect.Message
- func (x *Backup_ClusterMetadata) Reset()
- func (x *Backup_ClusterMetadata) String() string
- type Backup_ClusterMetadata_AnthosVersion
- type Backup_ClusterMetadata_GkeVersion
- type Backup_SelectedApplications
- type Backup_SelectedNamespaces
- type Backup_State
- func (Backup_State) Descriptor() protoreflect.EnumDescriptor
- func (x Backup_State) Enum() *Backup_State
- func (Backup_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x Backup_State) Number() protoreflect.EnumNumber
- func (x Backup_State) String() string
- func (Backup_State) Type() protoreflect.EnumType
- type EncryptionKey
- type NamespacedName
- func (*NamespacedName) Descriptor() ([]byte, []int)deprecated
- 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
- type NamespacedNames
- func (*NamespacedNames) Descriptor() ([]byte, []int)deprecated
- func (x *NamespacedNames) GetNamespacedNames() []*NamespacedName
- func (*NamespacedNames) ProtoMessage()
- func (x *NamespacedNames) ProtoReflect() protoreflect.Message
- func (x *NamespacedNames) Reset()
- func (x *NamespacedNames) String() string
- type Namespaces
- type Restore
- func (*Restore) Descriptor() ([]byte, []int)deprecated
- func (x *Restore) GetBackup() string
- func (x *Restore) GetCluster() string
- func (x *Restore) GetCompleteTime() *timestamppb.Timestamp
- func (x *Restore) GetCreateTime() *timestamppb.Timestamp
- func (x *Restore) GetDescription() string
- func (x *Restore) GetEtag() string
- func (x *Restore) GetLabels() map[string]string
- func (x *Restore) GetName() string
- func (x *Restore) GetResourcesExcludedCount() int32
- func (x *Restore) GetResourcesFailedCount() int32
- func (x *Restore) GetResourcesRestoredCount() int32
- func (x *Restore) GetRestoreConfig() *RestoreConfig
- func (x *Restore) GetState() Restore_State
- func (x *Restore) GetStateReason() string
- func (x *Restore) GetUid() string
- func (x *Restore) GetUpdateTime() *timestamppb.Timestamp
- func (x *Restore) GetVolumesRestoredCount() int32
- func (*Restore) ProtoMessage()
- func (x *Restore) ProtoReflect() protoreflect.Message
- func (x *Restore) Reset()
- func (x *Restore) String() string
- type RestoreConfig
- func (*RestoreConfig) Descriptor() ([]byte, []int)deprecated
- 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
- type RestoreConfig_ClusterResourceConflictPolicy
- func (RestoreConfig_ClusterResourceConflictPolicy) Descriptor() protoreflect.EnumDescriptor
- func (x RestoreConfig_ClusterResourceConflictPolicy) Enum() *RestoreConfig_ClusterResourceConflictPolicy
- func (RestoreConfig_ClusterResourceConflictPolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x RestoreConfig_ClusterResourceConflictPolicy) Number() protoreflect.EnumNumber
- func (x RestoreConfig_ClusterResourceConflictPolicy) String() string
- func (RestoreConfig_ClusterResourceConflictPolicy) Type() protoreflect.EnumType
- type RestoreConfig_ClusterResourceRestoreScope
- func (*RestoreConfig_ClusterResourceRestoreScope) Descriptor() ([]byte, []int)deprecated
- 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
- type RestoreConfig_GroupKind
- func (*RestoreConfig_GroupKind) Descriptor() ([]byte, []int)deprecated
- 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
- type RestoreConfig_NamespacedResourceRestoreMode
- func (RestoreConfig_NamespacedResourceRestoreMode) Descriptor() protoreflect.EnumDescriptor
- func (x RestoreConfig_NamespacedResourceRestoreMode) Enum() *RestoreConfig_NamespacedResourceRestoreMode
- func (RestoreConfig_NamespacedResourceRestoreMode) EnumDescriptor() ([]byte, []int)deprecated
- func (x RestoreConfig_NamespacedResourceRestoreMode) Number() protoreflect.EnumNumber
- func (x RestoreConfig_NamespacedResourceRestoreMode) String() string
- func (RestoreConfig_NamespacedResourceRestoreMode) Type() protoreflect.EnumType
- type RestoreConfig_SelectedApplications
- type RestoreConfig_SelectedNamespaces
- type RestoreConfig_SubstitutionRule
- func (*RestoreConfig_SubstitutionRule) Descriptor() ([]byte, []int)deprecated
- 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
- type RestoreConfig_VolumeDataRestorePolicy
- func (RestoreConfig_VolumeDataRestorePolicy) Descriptor() protoreflect.EnumDescriptor
- func (x RestoreConfig_VolumeDataRestorePolicy) Enum() *RestoreConfig_VolumeDataRestorePolicy
- func (RestoreConfig_VolumeDataRestorePolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x RestoreConfig_VolumeDataRestorePolicy) Number() protoreflect.EnumNumber
- func (x RestoreConfig_VolumeDataRestorePolicy) String() string
- func (RestoreConfig_VolumeDataRestorePolicy) Type() protoreflect.EnumType
- type RestoreEventData
- type RestorePlan
- func (*RestorePlan) Descriptor() ([]byte, []int)deprecated
- func (x *RestorePlan) GetBackupPlan() string
- func (x *RestorePlan) GetCluster() string
- func (x *RestorePlan) GetCreateTime() *timestamppb.Timestamp
- func (x *RestorePlan) GetDescription() string
- func (x *RestorePlan) GetEtag() string
- func (x *RestorePlan) GetLabels() map[string]string
- func (x *RestorePlan) GetName() string
- func (x *RestorePlan) GetRestoreConfig() *RestoreConfig
- func (x *RestorePlan) GetUid() string
- func (x *RestorePlan) GetUpdateTime() *timestamppb.Timestamp
- func (*RestorePlan) ProtoMessage()
- func (x *RestorePlan) ProtoReflect() protoreflect.Message
- func (x *RestorePlan) Reset()
- func (x *RestorePlan) String() string
- type RestorePlanEventData
- func (*RestorePlanEventData) Descriptor() ([]byte, []int)deprecated
- func (x *RestorePlanEventData) GetPayload() *RestorePlan
- func (*RestorePlanEventData) ProtoMessage()
- func (x *RestorePlanEventData) ProtoReflect() protoreflect.Message
- func (x *RestorePlanEventData) Reset()
- func (x *RestorePlanEventData) String() string
- type Restore_State
- func (Restore_State) Descriptor() protoreflect.EnumDescriptor
- func (x Restore_State) Enum() *Restore_State
- func (Restore_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x Restore_State) Number() protoreflect.EnumNumber
- func (x Restore_State) String() string
- func (Restore_State) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
var ( Backup_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "CREATING", 2: "IN_PROGRESS", 3: "SUCCEEDED", 4: "FAILED", 5: "DELETING", } Backup_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "CREATING": 1, "IN_PROGRESS": 2, "SUCCEEDED": 3, "FAILED": 4, "DELETING": 5, } )
Enum value maps for Backup_State.
var ( Restore_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "CREATING", 2: "IN_PROGRESS", 3: "SUCCEEDED", 4: "FAILED", 5: "DELETING", } Restore_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "CREATING": 1, "IN_PROGRESS": 2, "SUCCEEDED": 3, "FAILED": 4, "DELETING": 5, } )
Enum value maps for Restore_State.
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_VolumeDataRestorePolicy.
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_ClusterResourceConflictPolicy.
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 RestoreConfig_NamespacedResourceRestoreMode.
var File_cloud_gkebackup_v1_data_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Backup ¶
type Backup struct { // Output only. The fully qualified name of the Backup. // `projects/*/locations/*/backupPlans/*/backups/*` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Output only. Server generated global unique identifier of // [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"` // Output only. The timestamp when this Backup resource was created. CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // Output only. The timestamp when this Backup resource was last updated. UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // 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. Manual bool `protobuf:"varint,5,opt,name=manual,proto3" json:"manual,omitempty"` // A set of custom labels supplied by user. Labels map[string]string `` /* 153-byte string literal not displayed */ // 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][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_delete_lock_days] // setting and may only be increased // (either at creation time or in a subsequent update). DeleteLockDays int32 `protobuf:"varint,7,opt,name=delete_lock_days,json=deleteLockDays,proto3" json:"delete_lock_days,omitempty"` // Output only. The time at which an existing delete lock will expire for this // backup (calculated from create_time + // [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]). DeleteLockExpireTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=delete_lock_expire_time,json=deleteLockExpireTime,proto3" json:"delete_lock_expire_time,omitempty"` // 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][google.cloud.gkebackup.v1.Backup.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][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days] // value. RetainDays int32 `protobuf:"varint,9,opt,name=retain_days,json=retainDays,proto3" json:"retain_days,omitempty"` // Output only. The time at which this Backup will be automatically deleted // (calculated from create_time + // [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]). RetainExpireTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=retain_expire_time,json=retainExpireTime,proto3" json:"retain_expire_time,omitempty"` // Output only. The customer managed encryption key that was used to encrypt // the Backup's artifacts. Inherited from the parent BackupPlan's // [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key] // value. EncryptionKey *EncryptionKey `protobuf:"bytes,11,opt,name=encryption_key,json=encryptionKey,proto3" json:"encryption_key,omitempty"` // Defines the "scope" of the Backup - which namespaced resources in the // cluster were included in the Backup. Inherited from the parent // BackupPlan's // [backup_scope][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.backup_scope] // value. // // Types that are assignable to BackupScope: // // *Backup_AllNamespaces // *Backup_SelectedNamespaces // *Backup_SelectedApplications BackupScope isBackup_BackupScope `protobuf_oneof:"backup_scope"` // Output only. Whether or not the Backup contains volume data. Controlled by // the parent BackupPlan's // [include_volume_data][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_volume_data] // value. ContainsVolumeData bool `protobuf:"varint,15,opt,name=contains_volume_data,json=containsVolumeData,proto3" json:"contains_volume_data,omitempty"` // Output only. Whether or not the Backup contains Kubernetes Secrets. // Controlled by the parent BackupPlan's // [include_secrets][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_secrets] // value. ContainsSecrets bool `protobuf:"varint,16,opt,name=contains_secrets,json=containsSecrets,proto3" json:"contains_secrets,omitempty"` // Output only. Information about the GKE cluster from which this Backup was // created. ClusterMetadata *Backup_ClusterMetadata `protobuf:"bytes,17,opt,name=cluster_metadata,json=clusterMetadata,proto3" json:"cluster_metadata,omitempty"` // Output only. Current state of the Backup State Backup_State `protobuf:"varint,18,opt,name=state,proto3,enum=google.events.cloud.gkebackup.v1.Backup_State" json:"state,omitempty"` // Output only. Human-readable description of why the backup is in the current // `state`. StateReason string `protobuf:"bytes,19,opt,name=state_reason,json=stateReason,proto3" json:"state_reason,omitempty"` // Output only. Completion time of the Backup CompleteTime *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"` // Output only. The total number of Kubernetes resources included in the // Backup. ResourceCount int32 `protobuf:"varint,21,opt,name=resource_count,json=resourceCount,proto3" json:"resource_count,omitempty"` // Output only. The total number of volume backups contained in the Backup. VolumeCount int32 `protobuf:"varint,22,opt,name=volume_count,json=volumeCount,proto3" json:"volume_count,omitempty"` // Output only. The total size of the Backup in bytes = config backup size + // sum(volume backup sizes) SizeBytes int64 `protobuf:"varint,23,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"` // 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. Etag string `protobuf:"bytes,24,opt,name=etag,proto3" json:"etag,omitempty"` // User specified descriptive string for this Backup. Description string `protobuf:"bytes,25,opt,name=description,proto3" json:"description,omitempty"` // Output only. The total number of Kubernetes Pods contained in the Backup. PodCount int32 `protobuf:"varint,26,opt,name=pod_count,json=podCount,proto3" json:"pod_count,omitempty"` // Output only. The size of the config backup in bytes. ConfigBackupSizeBytes int64 `` /* 130-byte string literal not displayed */ // contains filtered or unexported fields }
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
func (*Backup) Descriptor
deprecated
func (*Backup) GetAllNamespaces ¶
func (*Backup) GetBackupScope ¶
func (m *Backup) GetBackupScope() isBackup_BackupScope
func (*Backup) GetClusterMetadata ¶
func (x *Backup) GetClusterMetadata() *Backup_ClusterMetadata
func (*Backup) GetCompleteTime ¶
func (x *Backup) GetCompleteTime() *timestamppb.Timestamp
func (*Backup) GetConfigBackupSizeBytes ¶
func (*Backup) GetContainsSecrets ¶
func (*Backup) GetContainsVolumeData ¶
func (*Backup) GetCreateTime ¶
func (x *Backup) GetCreateTime() *timestamppb.Timestamp
func (*Backup) GetDeleteLockDays ¶
func (*Backup) GetDeleteLockExpireTime ¶
func (x *Backup) GetDeleteLockExpireTime() *timestamppb.Timestamp
func (*Backup) GetDescription ¶
func (*Backup) GetEncryptionKey ¶
func (x *Backup) GetEncryptionKey() *EncryptionKey
func (*Backup) GetPodCount ¶
func (*Backup) GetResourceCount ¶
func (*Backup) GetRetainDays ¶
func (*Backup) GetRetainExpireTime ¶
func (x *Backup) GetRetainExpireTime() *timestamppb.Timestamp
func (*Backup) GetSelectedApplications ¶
func (x *Backup) GetSelectedApplications() *NamespacedNames
func (*Backup) GetSelectedNamespaces ¶
func (x *Backup) GetSelectedNamespaces() *Namespaces
func (*Backup) GetSizeBytes ¶
func (*Backup) GetState ¶
func (x *Backup) GetState() Backup_State
func (*Backup) GetStateReason ¶
func (*Backup) GetUpdateTime ¶
func (x *Backup) GetUpdateTime() *timestamppb.Timestamp
func (*Backup) GetVolumeCount ¶
func (*Backup) ProtoMessage ¶
func (*Backup) ProtoMessage()
func (*Backup) ProtoReflect ¶
func (x *Backup) ProtoReflect() protoreflect.Message
type BackupEventData ¶
type BackupEventData struct { // Optional. The Backup event payload. Unset for deletion events. Payload *Backup `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"` // contains filtered or unexported fields }
The data within all Backup events.
func (*BackupEventData) Descriptor
deprecated
func (*BackupEventData) Descriptor() ([]byte, []int)
Deprecated: Use BackupEventData.ProtoReflect.Descriptor instead.
func (*BackupEventData) GetPayload ¶
func (x *BackupEventData) GetPayload() *Backup
func (*BackupEventData) ProtoMessage ¶
func (*BackupEventData) ProtoMessage()
func (*BackupEventData) ProtoReflect ¶
func (x *BackupEventData) ProtoReflect() protoreflect.Message
func (*BackupEventData) Reset ¶
func (x *BackupEventData) Reset()
func (*BackupEventData) String ¶
func (x *BackupEventData) String() string
type BackupPlan ¶
type BackupPlan struct { // Output only. The full name of the BackupPlan resource. // Format: `projects/*/locations/*/backupPlans/*` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Output only. Server generated global unique identifier of // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"` // Output only. The timestamp when this BackupPlan resource was created. CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // Output only. The timestamp when this BackupPlan resource was last // updated. UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // User specified descriptive string for this BackupPlan. Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` // Required. Immutable. The source cluster from which Backups will be created // via this BackupPlan. Valid formats: // // - `projects/*/locations/*/clusters/*` // - `projects/*/zones/*/clusters/*` Cluster string `protobuf:"bytes,6,opt,name=cluster,proto3" json:"cluster,omitempty"` // RetentionPolicy governs lifecycle of Backups created under this plan. RetentionPolicy *BackupPlan_RetentionPolicy `protobuf:"bytes,7,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"` // A set of custom labels supplied by user. Labels map[string]string `` /* 153-byte string literal not displayed */ // Defines a schedule for automatic Backup creation via this BackupPlan. BackupSchedule *BackupPlan_Schedule `protobuf:"bytes,9,opt,name=backup_schedule,json=backupSchedule,proto3" json:"backup_schedule,omitempty"` // Output only. `etag` is used for optimistic concurrency control as a way to // help prevent simultaneous updates of a backup plan from overwriting each // other. It is strongly suggested that systems make use of the 'etag' in the // read-modify-write cycle to perform BackupPlan updates in order to avoid // race conditions: An `etag` is returned in the response to `GetBackupPlan`, // and systems are expected to put that etag in the request to // `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change // will be applied to the same version of the resource. Etag string `protobuf:"bytes,10,opt,name=etag,proto3" json:"etag,omitempty"` // This flag indicates whether this BackupPlan has been deactivated. // Setting this field to True locks the BackupPlan such that no further // updates will be allowed (except deletes), including the deactivated field // itself. It also prevents any new Backups from being created via this // BackupPlan (including scheduled Backups). // // Default: False Deactivated bool `protobuf:"varint,11,opt,name=deactivated,proto3" json:"deactivated,omitempty"` // Defines the configuration of Backups created via this BackupPlan. BackupConfig *BackupPlan_BackupConfig `protobuf:"bytes,12,opt,name=backup_config,json=backupConfig,proto3" json:"backup_config,omitempty"` // Output only. The number of Kubernetes Pods backed up in the // last successful Backup created via this BackupPlan. ProtectedPodCount int32 `protobuf:"varint,13,opt,name=protected_pod_count,json=protectedPodCount,proto3" json:"protected_pod_count,omitempty"` // contains filtered or unexported fields }
Defines the configuration and scheduling for a "line" of Backups.
func (*BackupPlan) Descriptor
deprecated
func (*BackupPlan) Descriptor() ([]byte, []int)
Deprecated: Use BackupPlan.ProtoReflect.Descriptor instead.
func (*BackupPlan) GetBackupConfig ¶
func (x *BackupPlan) GetBackupConfig() *BackupPlan_BackupConfig
func (*BackupPlan) GetBackupSchedule ¶
func (x *BackupPlan) GetBackupSchedule() *BackupPlan_Schedule
func (*BackupPlan) GetCluster ¶
func (x *BackupPlan) GetCluster() string
func (*BackupPlan) GetCreateTime ¶
func (x *BackupPlan) GetCreateTime() *timestamppb.Timestamp
func (*BackupPlan) GetDeactivated ¶
func (x *BackupPlan) GetDeactivated() bool
func (*BackupPlan) GetDescription ¶
func (x *BackupPlan) GetDescription() string
func (*BackupPlan) GetEtag ¶
func (x *BackupPlan) GetEtag() string
func (*BackupPlan) GetLabels ¶
func (x *BackupPlan) GetLabels() map[string]string
func (*BackupPlan) GetName ¶
func (x *BackupPlan) GetName() string
func (*BackupPlan) GetProtectedPodCount ¶
func (x *BackupPlan) GetProtectedPodCount() int32
func (*BackupPlan) GetRetentionPolicy ¶
func (x *BackupPlan) GetRetentionPolicy() *BackupPlan_RetentionPolicy
func (*BackupPlan) GetUid ¶
func (x *BackupPlan) GetUid() string
func (*BackupPlan) GetUpdateTime ¶
func (x *BackupPlan) GetUpdateTime() *timestamppb.Timestamp
func (*BackupPlan) ProtoMessage ¶
func (*BackupPlan) ProtoMessage()
func (*BackupPlan) ProtoReflect ¶
func (x *BackupPlan) ProtoReflect() protoreflect.Message
func (*BackupPlan) Reset ¶
func (x *BackupPlan) Reset()
func (*BackupPlan) String ¶
func (x *BackupPlan) String() string
type BackupPlanEventData ¶
type BackupPlanEventData struct { // Optional. The BackupPlan event payload. Unset for deletion events. Payload *BackupPlan `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"` // contains filtered or unexported fields }
The data within all BackupPlan events.
func (*BackupPlanEventData) Descriptor
deprecated
func (*BackupPlanEventData) Descriptor() ([]byte, []int)
Deprecated: Use BackupPlanEventData.ProtoReflect.Descriptor instead.
func (*BackupPlanEventData) GetPayload ¶
func (x *BackupPlanEventData) GetPayload() *BackupPlan
func (*BackupPlanEventData) ProtoMessage ¶
func (*BackupPlanEventData) ProtoMessage()
func (*BackupPlanEventData) ProtoReflect ¶
func (x *BackupPlanEventData) ProtoReflect() protoreflect.Message
func (*BackupPlanEventData) Reset ¶
func (x *BackupPlanEventData) Reset()
func (*BackupPlanEventData) String ¶
func (x *BackupPlanEventData) String() string
type BackupPlan_BackupConfig ¶
type BackupPlan_BackupConfig struct { // This defines the "scope" of the Backup - which namespaced // resources in the cluster will be included in a Backup. // Exactly one of the fields of backup_scope MUST be specified. // // Types that are assignable to BackupScope: // // *BackupPlan_BackupConfig_AllNamespaces // *BackupPlan_BackupConfig_SelectedNamespaces // *BackupPlan_BackupConfig_SelectedApplications BackupScope isBackupPlan_BackupConfig_BackupScope `protobuf_oneof:"backup_scope"` // This flag specifies whether volume data should be backed up when // PVCs are included in the scope of a Backup. // // Default: False IncludeVolumeData bool `protobuf:"varint,4,opt,name=include_volume_data,json=includeVolumeData,proto3" json:"include_volume_data,omitempty"` // This flag specifies whether Kubernetes Secret resources should be // included when they fall into the scope of Backups. // // Default: False IncludeSecrets bool `protobuf:"varint,5,opt,name=include_secrets,json=includeSecrets,proto3" json:"include_secrets,omitempty"` // This defines a customer managed encryption key that will be used to // encrypt the "config" portion (the Kubernetes resources) of Backups // created via this plan. // // Default (empty): Config backup artifacts will not be encrypted. EncryptionKey *EncryptionKey `protobuf:"bytes,6,opt,name=encryption_key,json=encryptionKey,proto3" json:"encryption_key,omitempty"` // contains filtered or unexported fields }
BackupConfig defines the configuration of Backups created via this BackupPlan.
func (*BackupPlan_BackupConfig) Descriptor
deprecated
func (*BackupPlan_BackupConfig) Descriptor() ([]byte, []int)
Deprecated: Use BackupPlan_BackupConfig.ProtoReflect.Descriptor instead.
func (*BackupPlan_BackupConfig) GetAllNamespaces ¶
func (x *BackupPlan_BackupConfig) GetAllNamespaces() bool
func (*BackupPlan_BackupConfig) GetBackupScope ¶
func (m *BackupPlan_BackupConfig) GetBackupScope() isBackupPlan_BackupConfig_BackupScope
func (*BackupPlan_BackupConfig) GetEncryptionKey ¶
func (x *BackupPlan_BackupConfig) GetEncryptionKey() *EncryptionKey
func (*BackupPlan_BackupConfig) GetIncludeSecrets ¶
func (x *BackupPlan_BackupConfig) GetIncludeSecrets() bool
func (*BackupPlan_BackupConfig) GetIncludeVolumeData ¶
func (x *BackupPlan_BackupConfig) GetIncludeVolumeData() bool
func (*BackupPlan_BackupConfig) GetSelectedApplications ¶
func (x *BackupPlan_BackupConfig) GetSelectedApplications() *NamespacedNames
func (*BackupPlan_BackupConfig) GetSelectedNamespaces ¶
func (x *BackupPlan_BackupConfig) GetSelectedNamespaces() *Namespaces
func (*BackupPlan_BackupConfig) ProtoMessage ¶
func (*BackupPlan_BackupConfig) ProtoMessage()
func (*BackupPlan_BackupConfig) ProtoReflect ¶
func (x *BackupPlan_BackupConfig) ProtoReflect() protoreflect.Message
func (*BackupPlan_BackupConfig) Reset ¶
func (x *BackupPlan_BackupConfig) Reset()
func (*BackupPlan_BackupConfig) String ¶
func (x *BackupPlan_BackupConfig) String() string
type BackupPlan_BackupConfig_AllNamespaces ¶
type BackupPlan_BackupConfig_AllNamespaces struct { // If True, include all namespaced resources AllNamespaces bool `protobuf:"varint,1,opt,name=all_namespaces,json=allNamespaces,proto3,oneof"` }
type BackupPlan_BackupConfig_SelectedApplications ¶
type BackupPlan_BackupConfig_SelectedApplications struct { // If set, include just the resources referenced by the listed // ProtectedApplications. SelectedApplications *NamespacedNames `protobuf:"bytes,3,opt,name=selected_applications,json=selectedApplications,proto3,oneof"` }
type BackupPlan_BackupConfig_SelectedNamespaces ¶
type BackupPlan_BackupConfig_SelectedNamespaces struct { // If set, include just the resources in the listed namespaces. SelectedNamespaces *Namespaces `protobuf:"bytes,2,opt,name=selected_namespaces,json=selectedNamespaces,proto3,oneof"` }
type BackupPlan_RetentionPolicy ¶
type BackupPlan_RetentionPolicy struct { // Minimum age for Backups created via this BackupPlan (in days). // This field MUST be an integer value between 0-90 (inclusive). // A Backup created under this BackupPlan will NOT be deletable until it // reaches Backup's (create_time + backup_delete_lock_days). // Updating this field of a BackupPlan does NOT affect existing Backups // under it. Backups created AFTER a successful update will inherit // the new value. // // Default: 0 (no delete blocking) BackupDeleteLockDays int32 `` /* 126-byte string literal not displayed */ // The default maximum age of a Backup created via this BackupPlan. // This field MUST be an integer value >= 0 and <= 365. // If specified, a Backup created under this BackupPlan will be // automatically deleted after its age reaches (create_time + // backup_retain_days). // If not specified, Backups created under this BackupPlan will NOT be // subject to automatic deletion. // Updating this field does NOT affect existing Backups under it. Backups // created AFTER a successful update will automatically pick up the new // value. // NOTE: backup_retain_days must be >= // [backup_delete_lock_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_delete_lock_days]. // If // [cron_schedule][google.cloud.gkebackup.v1.BackupPlan.Schedule.cron_schedule] // is defined, then this must be // <= 360 * the creation interval. // // Default: 0 (no automatic deletion) BackupRetainDays int32 `protobuf:"varint,2,opt,name=backup_retain_days,json=backupRetainDays,proto3" json:"backup_retain_days,omitempty"` // This flag denotes whether 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: False Locked bool `protobuf:"varint,3,opt,name=locked,proto3" json:"locked,omitempty"` // contains filtered or unexported fields }
RetentionPolicy defines a Backup retention policy for a BackupPlan.
func (*BackupPlan_RetentionPolicy) Descriptor
deprecated
func (*BackupPlan_RetentionPolicy) Descriptor() ([]byte, []int)
Deprecated: Use BackupPlan_RetentionPolicy.ProtoReflect.Descriptor instead.
func (*BackupPlan_RetentionPolicy) GetBackupDeleteLockDays ¶
func (x *BackupPlan_RetentionPolicy) GetBackupDeleteLockDays() int32
func (*BackupPlan_RetentionPolicy) GetBackupRetainDays ¶
func (x *BackupPlan_RetentionPolicy) GetBackupRetainDays() int32
func (*BackupPlan_RetentionPolicy) GetLocked ¶
func (x *BackupPlan_RetentionPolicy) GetLocked() bool
func (*BackupPlan_RetentionPolicy) ProtoMessage ¶
func (*BackupPlan_RetentionPolicy) ProtoMessage()
func (*BackupPlan_RetentionPolicy) ProtoReflect ¶
func (x *BackupPlan_RetentionPolicy) ProtoReflect() protoreflect.Message
func (*BackupPlan_RetentionPolicy) Reset ¶
func (x *BackupPlan_RetentionPolicy) Reset()
func (*BackupPlan_RetentionPolicy) String ¶
func (x *BackupPlan_RetentionPolicy) String() string
type BackupPlan_Schedule ¶
type BackupPlan_Schedule struct { // A standard [cron](https://wikipedia.com/wiki/cron) string that defines a // repeating schedule for creating Backups via this BackupPlan. If this is // defined, then // [backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days] // must also be defined. // // Default (empty): no automatic backup creation will occur. CronSchedule string `protobuf:"bytes,1,opt,name=cron_schedule,json=cronSchedule,proto3" json:"cron_schedule,omitempty"` // This flag denotes whether automatic Backup creation is paused for this // BackupPlan. // // Default: False Paused bool `protobuf:"varint,2,opt,name=paused,proto3" json:"paused,omitempty"` // contains filtered or unexported fields }
Schedule defines scheduling parameters for automatically creating Backups via this BackupPlan.
func (*BackupPlan_Schedule) Descriptor
deprecated
func (*BackupPlan_Schedule) Descriptor() ([]byte, []int)
Deprecated: Use BackupPlan_Schedule.ProtoReflect.Descriptor instead.
func (*BackupPlan_Schedule) GetCronSchedule ¶
func (x *BackupPlan_Schedule) GetCronSchedule() string
func (*BackupPlan_Schedule) GetPaused ¶
func (x *BackupPlan_Schedule) GetPaused() bool
func (*BackupPlan_Schedule) ProtoMessage ¶
func (*BackupPlan_Schedule) ProtoMessage()
func (*BackupPlan_Schedule) ProtoReflect ¶
func (x *BackupPlan_Schedule) ProtoReflect() protoreflect.Message
func (*BackupPlan_Schedule) Reset ¶
func (x *BackupPlan_Schedule) Reset()
func (*BackupPlan_Schedule) String ¶
func (x *BackupPlan_Schedule) String() string
type Backup_AllNamespaces ¶
type Backup_AllNamespaces struct { // Output only. If True, all namespaces were included in the Backup. AllNamespaces bool `protobuf:"varint,12,opt,name=all_namespaces,json=allNamespaces,proto3,oneof"` }
type Backup_ClusterMetadata ¶
type Backup_ClusterMetadata struct { // 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 // [cluster][google.cloud.gkebackup.v1.BackupPlan.cluster] field. Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"` // The Kubernetes server version of the source cluster. K8SVersion string `protobuf:"bytes,2,opt,name=k8s_version,json=k8sVersion,proto3" json:"k8s_version,omitempty"` // A list of the Backup for GKE CRD versions found in the cluster. BackupCrdVersions map[string]string `` /* 202-byte string literal not displayed */ // Platform-specific version // // Types that are assignable to PlatformVersion: // // *Backup_ClusterMetadata_GkeVersion // *Backup_ClusterMetadata_AnthosVersion PlatformVersion isBackup_ClusterMetadata_PlatformVersion `protobuf_oneof:"platform_version"` // contains filtered or unexported fields }
Information about the GKE cluster from which this Backup was created.
func (*Backup_ClusterMetadata) Descriptor
deprecated
func (*Backup_ClusterMetadata) Descriptor() ([]byte, []int)
Deprecated: Use Backup_ClusterMetadata.ProtoReflect.Descriptor instead.
func (*Backup_ClusterMetadata) GetAnthosVersion ¶
func (x *Backup_ClusterMetadata) GetAnthosVersion() string
func (*Backup_ClusterMetadata) GetBackupCrdVersions ¶
func (x *Backup_ClusterMetadata) GetBackupCrdVersions() map[string]string
func (*Backup_ClusterMetadata) GetCluster ¶
func (x *Backup_ClusterMetadata) GetCluster() string
func (*Backup_ClusterMetadata) GetGkeVersion ¶
func (x *Backup_ClusterMetadata) GetGkeVersion() string
func (*Backup_ClusterMetadata) GetK8SVersion ¶
func (x *Backup_ClusterMetadata) GetK8SVersion() string
func (*Backup_ClusterMetadata) GetPlatformVersion ¶
func (m *Backup_ClusterMetadata) GetPlatformVersion() isBackup_ClusterMetadata_PlatformVersion
func (*Backup_ClusterMetadata) ProtoMessage ¶
func (*Backup_ClusterMetadata) ProtoMessage()
func (*Backup_ClusterMetadata) ProtoReflect ¶
func (x *Backup_ClusterMetadata) ProtoReflect() protoreflect.Message
func (*Backup_ClusterMetadata) Reset ¶
func (x *Backup_ClusterMetadata) Reset()
func (*Backup_ClusterMetadata) String ¶
func (x *Backup_ClusterMetadata) String() string
type Backup_ClusterMetadata_AnthosVersion ¶
type Backup_ClusterMetadata_AnthosVersion struct { // Anthos version AnthosVersion string `protobuf:"bytes,5,opt,name=anthos_version,json=anthosVersion,proto3,oneof"` }
type Backup_ClusterMetadata_GkeVersion ¶
type Backup_ClusterMetadata_GkeVersion struct { // GKE version GkeVersion string `protobuf:"bytes,4,opt,name=gke_version,json=gkeVersion,proto3,oneof"` }
type Backup_SelectedApplications ¶
type Backup_SelectedApplications struct { // Output only. If set, the list of ProtectedApplications whose resources // were included in the Backup. SelectedApplications *NamespacedNames `protobuf:"bytes,14,opt,name=selected_applications,json=selectedApplications,proto3,oneof"` }
type Backup_SelectedNamespaces ¶
type Backup_SelectedNamespaces struct { // Output only. If set, the list of namespaces that were included in the // Backup. SelectedNamespaces *Namespaces `protobuf:"bytes,13,opt,name=selected_namespaces,json=selectedNamespaces,proto3,oneof"` }
type Backup_State ¶
type Backup_State int32
State
const ( // The Backup resource is in the process of being created. Backup_STATE_UNSPECIFIED Backup_State = 0 // The Backup resource has been created and the associated BackupJob // Kubernetes resource has been injected into the source cluster. Backup_CREATING Backup_State = 1 // The gkebackup agent in the cluster has begun executing the backup // operation. Backup_IN_PROGRESS Backup_State = 2 // The backup operation has completed successfully. Backup_SUCCEEDED Backup_State = 3 // The backup operation has failed. Backup_FAILED Backup_State = 4 // This Backup resource (and its associated artifacts) is in the process // of being deleted. Backup_DELETING Backup_State = 5 )
func (Backup_State) Descriptor ¶
func (Backup_State) Descriptor() protoreflect.EnumDescriptor
func (Backup_State) Enum ¶
func (x Backup_State) Enum() *Backup_State
func (Backup_State) EnumDescriptor
deprecated
func (Backup_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Backup_State.Descriptor instead.
func (Backup_State) Number ¶
func (x Backup_State) Number() protoreflect.EnumNumber
func (Backup_State) String ¶
func (x Backup_State) String() string
func (Backup_State) Type ¶
func (Backup_State) Type() protoreflect.EnumType
type EncryptionKey ¶
type EncryptionKey struct { // Google Cloud KMS encryption key. Format: // `projects/*/locations/*/keyRings/*/cryptoKeys/*` 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 }
Defined a customer managed encryption key that will be used to encrypt Backup artifacts.
func (*EncryptionKey) Descriptor
deprecated
func (*EncryptionKey) Descriptor() ([]byte, []int)
Deprecated: Use EncryptionKey.ProtoReflect.Descriptor instead.
func (*EncryptionKey) GetGcpKmsEncryptionKey ¶
func (x *EncryptionKey) GetGcpKmsEncryptionKey() string
func (*EncryptionKey) ProtoMessage ¶
func (*EncryptionKey) ProtoMessage()
func (*EncryptionKey) ProtoReflect ¶
func (x *EncryptionKey) ProtoReflect() protoreflect.Message
func (*EncryptionKey) Reset ¶
func (x *EncryptionKey) Reset()
func (*EncryptionKey) String ¶
func (x *EncryptionKey) String() string
type NamespacedName ¶
type NamespacedName struct { // The Namespace of the Kubernetes resource. Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` // The name of the Kubernetes resource. Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
A reference to a namespaced resource in Kubernetes.
func (*NamespacedName) Descriptor
deprecated
func (*NamespacedName) Descriptor() ([]byte, []int)
Deprecated: Use NamespacedName.ProtoReflect.Descriptor instead.
func (*NamespacedName) GetName ¶
func (x *NamespacedName) GetName() string
func (*NamespacedName) GetNamespace ¶
func (x *NamespacedName) GetNamespace() string
func (*NamespacedName) ProtoMessage ¶
func (*NamespacedName) ProtoMessage()
func (*NamespacedName) ProtoReflect ¶
func (x *NamespacedName) ProtoReflect() protoreflect.Message
func (*NamespacedName) Reset ¶
func (x *NamespacedName) Reset()
func (*NamespacedName) String ¶
func (x *NamespacedName) String() string
type NamespacedNames ¶
type NamespacedNames struct { // A list of namespaced Kubernetes resources. NamespacedNames []*NamespacedName `protobuf:"bytes,1,rep,name=namespaced_names,json=namespacedNames,proto3" json:"namespaced_names,omitempty"` // contains filtered or unexported fields }
A list of namespaced Kubernetes resources.
func (*NamespacedNames) Descriptor
deprecated
func (*NamespacedNames) Descriptor() ([]byte, []int)
Deprecated: Use NamespacedNames.ProtoReflect.Descriptor instead.
func (*NamespacedNames) GetNamespacedNames ¶
func (x *NamespacedNames) GetNamespacedNames() []*NamespacedName
func (*NamespacedNames) ProtoMessage ¶
func (*NamespacedNames) ProtoMessage()
func (*NamespacedNames) ProtoReflect ¶
func (x *NamespacedNames) ProtoReflect() protoreflect.Message
func (*NamespacedNames) Reset ¶
func (x *NamespacedNames) Reset()
func (*NamespacedNames) String ¶
func (x *NamespacedNames) String() string
type Namespaces ¶
type Namespaces struct { // A list of Kubernetes Namespaces Namespaces []string `protobuf:"bytes,1,rep,name=namespaces,proto3" json:"namespaces,omitempty"` // contains filtered or unexported fields }
A list of Kubernetes Namespaces
func (*Namespaces) Descriptor
deprecated
func (*Namespaces) Descriptor() ([]byte, []int)
Deprecated: Use Namespaces.ProtoReflect.Descriptor instead.
func (*Namespaces) GetNamespaces ¶
func (x *Namespaces) GetNamespaces() []string
func (*Namespaces) ProtoMessage ¶
func (*Namespaces) ProtoMessage()
func (*Namespaces) ProtoReflect ¶
func (x *Namespaces) ProtoReflect() protoreflect.Message
func (*Namespaces) Reset ¶
func (x *Namespaces) Reset()
func (*Namespaces) String ¶
func (x *Namespaces) String() string
type Restore ¶
type Restore struct { // Output only. The full name of the Restore resource. // Format: `projects/*/locations/*/restorePlans/*/restores/*` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Output only. Server generated global unique identifier of // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"` // Output only. The timestamp when this Restore resource was created. CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // Output only. The timestamp when this Restore resource was last // updated. UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // User specified descriptive string for this Restore. Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` // Required. Immutable. A reference to the // [Backup][google.cloud.gkebackup.v1.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][google.cloud.gkebackup.v1.RestorePlan.backup_plan]. Format: // `projects/*/locations/*/backupPlans/*/backups/*`. Backup string `protobuf:"bytes,6,opt,name=backup,proto3" json:"backup,omitempty"` // 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][google.cloud.gkebackup.v1.RestorePlan.cluster] value. Cluster string `protobuf:"bytes,7,opt,name=cluster,proto3" json:"cluster,omitempty"` // Output only. Configuration of the Restore. Inherited from parent // RestorePlan's // [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config]. RestoreConfig *RestoreConfig `protobuf:"bytes,8,opt,name=restore_config,json=restoreConfig,proto3" json:"restore_config,omitempty"` // A set of custom labels supplied by user. Labels map[string]string `` /* 153-byte string literal not displayed */ // Output only. The current state of the Restore. State Restore_State `protobuf:"varint,10,opt,name=state,proto3,enum=google.events.cloud.gkebackup.v1.Restore_State" json:"state,omitempty"` // Output only. Human-readable description of why the Restore is in its // current state. StateReason string `protobuf:"bytes,11,opt,name=state_reason,json=stateReason,proto3" json:"state_reason,omitempty"` // Output only. Timestamp of when the restore operation completed. CompleteTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"` // Output only. Number of resources restored during the restore execution. ResourcesRestoredCount int32 `` /* 131-byte string literal not displayed */ // Output only. Number of resources excluded during the restore execution. ResourcesExcludedCount int32 `` /* 131-byte string literal not displayed */ // Output only. Number of resources that failed to be restored during the // restore execution. ResourcesFailedCount int32 `protobuf:"varint,15,opt,name=resources_failed_count,json=resourcesFailedCount,proto3" json:"resources_failed_count,omitempty"` // Output only. Number of volumes restored during the restore execution. VolumesRestoredCount int32 `protobuf:"varint,16,opt,name=volumes_restored_count,json=volumesRestoredCount,proto3" json:"volumes_restored_count,omitempty"` // 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. Etag string `protobuf:"bytes,17,opt,name=etag,proto3" json:"etag,omitempty"` // contains filtered or unexported fields }
Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 18
func (*Restore) Descriptor
deprecated
func (*Restore) GetCluster ¶
func (*Restore) GetCompleteTime ¶
func (x *Restore) GetCompleteTime() *timestamppb.Timestamp
func (*Restore) GetCreateTime ¶
func (x *Restore) GetCreateTime() *timestamppb.Timestamp
func (*Restore) GetDescription ¶
func (*Restore) GetResourcesExcludedCount ¶
func (*Restore) GetResourcesFailedCount ¶
func (*Restore) GetResourcesRestoredCount ¶
func (*Restore) GetRestoreConfig ¶
func (x *Restore) GetRestoreConfig() *RestoreConfig
func (*Restore) GetState ¶
func (x *Restore) GetState() Restore_State
func (*Restore) GetStateReason ¶
func (*Restore) GetUpdateTime ¶
func (x *Restore) GetUpdateTime() *timestamppb.Timestamp
func (*Restore) GetVolumesRestoredCount ¶
func (*Restore) ProtoMessage ¶
func (*Restore) ProtoMessage()
func (*Restore) ProtoReflect ¶
func (x *Restore) ProtoReflect() protoreflect.Message
type RestoreConfig ¶
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 `` /* 211-byte string literal not displayed */ // 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][google.cloud.gkebackup.v1.RestoreConfig.cluster_resource_restore_scope] // is not empty. ClusterResourceConflictPolicy RestoreConfig_ClusterResourceConflictPolicy `` /* 235-byte string literal not displayed */ // 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. NamespacedResourceRestoreMode RestoreConfig_NamespacedResourceRestoreMode `` /* 235-byte string literal not displayed */ // Identifies the cluster-scoped resources to restore from the Backup. // Not specifying it means NO cluster resource will be restored. ClusterResourceRestoreScope *RestoreConfig_ClusterResourceRestoreScope `` /* 146-byte string literal not displayed */ // 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. // // Note: Resources will never be restored into *managed* namespaces such as // `kube-system`, `kube-public`, or `kube-node-lease`. These namespaces // are silently skipped when // [all_namespaces][google.cloud.gkebackup.v1.RestoreConfig.all_namespaces] is // selected. Listing them explicitly will result in an error. // // 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 }
Configuration of a restore. Next id: 12
func (*RestoreConfig) Descriptor
deprecated
func (*RestoreConfig) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig.ProtoReflect.Descriptor instead.
func (*RestoreConfig) GetAllNamespaces ¶
func (x *RestoreConfig) GetAllNamespaces() bool
func (*RestoreConfig) GetClusterResourceConflictPolicy ¶
func (x *RestoreConfig) GetClusterResourceConflictPolicy() RestoreConfig_ClusterResourceConflictPolicy
func (*RestoreConfig) GetClusterResourceRestoreScope ¶
func (x *RestoreConfig) GetClusterResourceRestoreScope() *RestoreConfig_ClusterResourceRestoreScope
func (*RestoreConfig) GetNamespacedResourceRestoreMode ¶
func (x *RestoreConfig) GetNamespacedResourceRestoreMode() RestoreConfig_NamespacedResourceRestoreMode
func (*RestoreConfig) GetNamespacedResourceRestoreScope ¶
func (m *RestoreConfig) GetNamespacedResourceRestoreScope() isRestoreConfig_NamespacedResourceRestoreScope
func (*RestoreConfig) GetSelectedApplications ¶
func (x *RestoreConfig) GetSelectedApplications() *NamespacedNames
func (*RestoreConfig) GetSelectedNamespaces ¶
func (x *RestoreConfig) GetSelectedNamespaces() *Namespaces
func (*RestoreConfig) GetSubstitutionRules ¶
func (x *RestoreConfig) GetSubstitutionRules() []*RestoreConfig_SubstitutionRule
func (*RestoreConfig) GetVolumeDataRestorePolicy ¶
func (x *RestoreConfig) GetVolumeDataRestorePolicy() RestoreConfig_VolumeDataRestorePolicy
func (*RestoreConfig) ProtoMessage ¶
func (*RestoreConfig) ProtoMessage()
func (*RestoreConfig) ProtoReflect ¶
func (x *RestoreConfig) ProtoReflect() protoreflect.Message
func (*RestoreConfig) Reset ¶
func (x *RestoreConfig) Reset()
func (*RestoreConfig) String ¶
func (x *RestoreConfig) String() string
type RestoreConfig_AllNamespaces ¶
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"` }
type RestoreConfig_ClusterResourceConflictPolicy ¶
type RestoreConfig_ClusterResourceConflictPolicy int32
Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster.
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 ¶
func (RestoreConfig_ClusterResourceConflictPolicy) Descriptor() protoreflect.EnumDescriptor
func (RestoreConfig_ClusterResourceConflictPolicy) EnumDescriptor
deprecated
func (RestoreConfig_ClusterResourceConflictPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_ClusterResourceConflictPolicy.Descriptor instead.
func (RestoreConfig_ClusterResourceConflictPolicy) Number ¶
func (x RestoreConfig_ClusterResourceConflictPolicy) Number() protoreflect.EnumNumber
func (RestoreConfig_ClusterResourceConflictPolicy) String ¶
func (x RestoreConfig_ClusterResourceConflictPolicy) String() string
func (RestoreConfig_ClusterResourceConflictPolicy) Type ¶
func (RestoreConfig_ClusterResourceConflictPolicy) Type() protoreflect.EnumType
type RestoreConfig_ClusterResourceRestoreScope ¶
type RestoreConfig_ClusterResourceRestoreScope struct { // A list of cluster-scoped resource group kinds to restore from the // backup. If specified, only the selected resources will be restored. // Mutually exclusive to any other field in the message. SelectedGroupKinds []*RestoreConfig_GroupKind `protobuf:"bytes,1,rep,name=selected_group_kinds,json=selectedGroupKinds,proto3" json:"selected_group_kinds,omitempty"` // contains filtered or unexported fields }
Defines the scope of cluster-scoped resources to restore.
Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds. - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - Node - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode
Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume
func (*RestoreConfig_ClusterResourceRestoreScope) Descriptor
deprecated
func (*RestoreConfig_ClusterResourceRestoreScope) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_ClusterResourceRestoreScope.ProtoReflect.Descriptor instead.
func (*RestoreConfig_ClusterResourceRestoreScope) GetSelectedGroupKinds ¶
func (x *RestoreConfig_ClusterResourceRestoreScope) GetSelectedGroupKinds() []*RestoreConfig_GroupKind
func (*RestoreConfig_ClusterResourceRestoreScope) ProtoMessage ¶
func (*RestoreConfig_ClusterResourceRestoreScope) ProtoMessage()
func (*RestoreConfig_ClusterResourceRestoreScope) ProtoReflect ¶
func (x *RestoreConfig_ClusterResourceRestoreScope) ProtoReflect() protoreflect.Message
func (*RestoreConfig_ClusterResourceRestoreScope) Reset ¶
func (x *RestoreConfig_ClusterResourceRestoreScope) Reset()
func (*RestoreConfig_ClusterResourceRestoreScope) String ¶
func (x *RestoreConfig_ClusterResourceRestoreScope) String() string
type RestoreConfig_GroupKind ¶
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 }
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.
func (*RestoreConfig_GroupKind) Descriptor
deprecated
func (*RestoreConfig_GroupKind) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_GroupKind.ProtoReflect.Descriptor instead.
func (*RestoreConfig_GroupKind) GetResourceGroup ¶
func (x *RestoreConfig_GroupKind) GetResourceGroup() string
func (*RestoreConfig_GroupKind) GetResourceKind ¶
func (x *RestoreConfig_GroupKind) GetResourceKind() string
func (*RestoreConfig_GroupKind) ProtoMessage ¶
func (*RestoreConfig_GroupKind) ProtoMessage()
func (*RestoreConfig_GroupKind) ProtoReflect ¶
func (x *RestoreConfig_GroupKind) ProtoReflect() protoreflect.Message
func (*RestoreConfig_GroupKind) Reset ¶
func (x *RestoreConfig_GroupKind) Reset()
func (*RestoreConfig_GroupKind) String ¶
func (x *RestoreConfig_GroupKind) String() string
type RestoreConfig_NamespacedResourceRestoreMode ¶
type RestoreConfig_NamespacedResourceRestoreMode int32
Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster.
const ( // Unspecified (invalid). 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 ¶
func (RestoreConfig_NamespacedResourceRestoreMode) Descriptor() protoreflect.EnumDescriptor
func (RestoreConfig_NamespacedResourceRestoreMode) EnumDescriptor
deprecated
func (RestoreConfig_NamespacedResourceRestoreMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_NamespacedResourceRestoreMode.Descriptor instead.
func (RestoreConfig_NamespacedResourceRestoreMode) Number ¶
func (x RestoreConfig_NamespacedResourceRestoreMode) Number() protoreflect.EnumNumber
func (RestoreConfig_NamespacedResourceRestoreMode) String ¶
func (x RestoreConfig_NamespacedResourceRestoreMode) String() string
func (RestoreConfig_NamespacedResourceRestoreMode) Type ¶
func (RestoreConfig_NamespacedResourceRestoreMode) Type() protoreflect.EnumType
type RestoreConfig_SelectedApplications ¶
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 ¶
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"` }
type RestoreConfig_SubstitutionRule ¶
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"` // Required. 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 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 }
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.
func (*RestoreConfig_SubstitutionRule) Descriptor
deprecated
func (*RestoreConfig_SubstitutionRule) Descriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_SubstitutionRule.ProtoReflect.Descriptor instead.
func (*RestoreConfig_SubstitutionRule) GetNewValue ¶
func (x *RestoreConfig_SubstitutionRule) GetNewValue() string
func (*RestoreConfig_SubstitutionRule) GetOriginalValuePattern ¶
func (x *RestoreConfig_SubstitutionRule) GetOriginalValuePattern() string
func (*RestoreConfig_SubstitutionRule) GetTargetGroupKinds ¶
func (x *RestoreConfig_SubstitutionRule) GetTargetGroupKinds() []*RestoreConfig_GroupKind
func (*RestoreConfig_SubstitutionRule) GetTargetJsonPath ¶
func (x *RestoreConfig_SubstitutionRule) GetTargetJsonPath() string
func (*RestoreConfig_SubstitutionRule) GetTargetNamespaces ¶
func (x *RestoreConfig_SubstitutionRule) GetTargetNamespaces() []string
func (*RestoreConfig_SubstitutionRule) ProtoMessage ¶
func (*RestoreConfig_SubstitutionRule) ProtoMessage()
func (*RestoreConfig_SubstitutionRule) ProtoReflect ¶
func (x *RestoreConfig_SubstitutionRule) ProtoReflect() protoreflect.Message
func (*RestoreConfig_SubstitutionRule) Reset ¶
func (x *RestoreConfig_SubstitutionRule) Reset()
func (*RestoreConfig_SubstitutionRule) String ¶
func (x *RestoreConfig_SubstitutionRule) String() string
type RestoreConfig_VolumeDataRestorePolicy ¶
type RestoreConfig_VolumeDataRestorePolicy int32
Defines how volume data should be restored
const ( // Unspecified (illegal). 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 ¶
func (RestoreConfig_VolumeDataRestorePolicy) Descriptor() protoreflect.EnumDescriptor
func (RestoreConfig_VolumeDataRestorePolicy) EnumDescriptor
deprecated
func (RestoreConfig_VolumeDataRestorePolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use RestoreConfig_VolumeDataRestorePolicy.Descriptor instead.
func (RestoreConfig_VolumeDataRestorePolicy) Number ¶
func (x RestoreConfig_VolumeDataRestorePolicy) Number() protoreflect.EnumNumber
func (RestoreConfig_VolumeDataRestorePolicy) String ¶
func (x RestoreConfig_VolumeDataRestorePolicy) String() string
func (RestoreConfig_VolumeDataRestorePolicy) Type ¶
func (RestoreConfig_VolumeDataRestorePolicy) Type() protoreflect.EnumType
type RestoreEventData ¶
type RestoreEventData struct { // Optional. The Restore event payload. Unset for deletion events. Payload *Restore `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"` // contains filtered or unexported fields }
The data within all Restore events.
func (*RestoreEventData) Descriptor
deprecated
func (*RestoreEventData) Descriptor() ([]byte, []int)
Deprecated: Use RestoreEventData.ProtoReflect.Descriptor instead.
func (*RestoreEventData) GetPayload ¶
func (x *RestoreEventData) GetPayload() *Restore
func (*RestoreEventData) ProtoMessage ¶
func (*RestoreEventData) ProtoMessage()
func (*RestoreEventData) ProtoReflect ¶
func (x *RestoreEventData) ProtoReflect() protoreflect.Message
func (*RestoreEventData) Reset ¶
func (x *RestoreEventData) Reset()
func (*RestoreEventData) String ¶
func (x *RestoreEventData) String() string
type RestorePlan ¶
type RestorePlan struct { // Output only. The full name of the RestorePlan resource. // Format: `projects/*/locations/*/restorePlans/*`. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Output only. Server generated global unique identifier of // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"` // Output only. The timestamp when this RestorePlan resource was // created. CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // Output only. The timestamp when this RestorePlan resource was last // updated. UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // User specified descriptive string for this RestorePlan. Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` // Required. Immutable. A reference to the // [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may // be used as the source for Restores created via this RestorePlan. Format: // `projects/*/locations/*/backupPlans/*`. BackupPlan string `protobuf:"bytes,6,opt,name=backup_plan,json=backupPlan,proto3" json:"backup_plan,omitempty"` // Required. Immutable. The target cluster into which Restores created via // this RestorePlan will restore data. NOTE: the cluster's region must be the // same as the RestorePlan. Valid formats: // // - `projects/*/locations/*/clusters/*` // - `projects/*/zones/*/clusters/*` Cluster string `protobuf:"bytes,7,opt,name=cluster,proto3" json:"cluster,omitempty"` // Required. Configuration of Restores created via this RestorePlan. RestoreConfig *RestoreConfig `protobuf:"bytes,8,opt,name=restore_config,json=restoreConfig,proto3" json:"restore_config,omitempty"` // A set of custom labels supplied by user. Labels map[string]string `` /* 153-byte string literal not displayed */ // 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 `GetRestorePlan`, // and systems are expected to put that etag in the request to // `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change // will be applied to the same version of the resource. Etag string `protobuf:"bytes,10,opt,name=etag,proto3" json:"etag,omitempty"` // contains filtered or unexported fields }
The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. Next id: 13
func (*RestorePlan) Descriptor
deprecated
func (*RestorePlan) Descriptor() ([]byte, []int)
Deprecated: Use RestorePlan.ProtoReflect.Descriptor instead.
func (*RestorePlan) GetBackupPlan ¶
func (x *RestorePlan) GetBackupPlan() string
func (*RestorePlan) GetCluster ¶
func (x *RestorePlan) GetCluster() string
func (*RestorePlan) GetCreateTime ¶
func (x *RestorePlan) GetCreateTime() *timestamppb.Timestamp
func (*RestorePlan) GetDescription ¶
func (x *RestorePlan) GetDescription() string
func (*RestorePlan) GetEtag ¶
func (x *RestorePlan) GetEtag() string
func (*RestorePlan) GetLabels ¶
func (x *RestorePlan) GetLabels() map[string]string
func (*RestorePlan) GetName ¶
func (x *RestorePlan) GetName() string
func (*RestorePlan) GetRestoreConfig ¶
func (x *RestorePlan) GetRestoreConfig() *RestoreConfig
func (*RestorePlan) GetUid ¶
func (x *RestorePlan) GetUid() string
func (*RestorePlan) GetUpdateTime ¶
func (x *RestorePlan) GetUpdateTime() *timestamppb.Timestamp
func (*RestorePlan) ProtoMessage ¶
func (*RestorePlan) ProtoMessage()
func (*RestorePlan) ProtoReflect ¶
func (x *RestorePlan) ProtoReflect() protoreflect.Message
func (*RestorePlan) Reset ¶
func (x *RestorePlan) Reset()
func (*RestorePlan) String ¶
func (x *RestorePlan) String() string
type RestorePlanEventData ¶
type RestorePlanEventData struct { // Optional. The RestorePlan event payload. Unset for deletion events. Payload *RestorePlan `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"` // contains filtered or unexported fields }
The data within all RestorePlan events.
func (*RestorePlanEventData) Descriptor
deprecated
func (*RestorePlanEventData) Descriptor() ([]byte, []int)
Deprecated: Use RestorePlanEventData.ProtoReflect.Descriptor instead.
func (*RestorePlanEventData) GetPayload ¶
func (x *RestorePlanEventData) GetPayload() *RestorePlan
func (*RestorePlanEventData) ProtoMessage ¶
func (*RestorePlanEventData) ProtoMessage()
func (*RestorePlanEventData) ProtoReflect ¶
func (x *RestorePlanEventData) ProtoReflect() protoreflect.Message
func (*RestorePlanEventData) Reset ¶
func (x *RestorePlanEventData) Reset()
func (*RestorePlanEventData) String ¶
func (x *RestorePlanEventData) String() string
type Restore_State ¶
type Restore_State int32
Possible values for state of the Restore.
const ( // The Restore resource is in the process of being created. Restore_STATE_UNSPECIFIED Restore_State = 0 // The Restore resource has been created and the associated RestoreJob // Kubernetes resource has been injected into target cluster. Restore_CREATING Restore_State = 1 // The gkebackup agent in the cluster has begun executing the restore // operation. Restore_IN_PROGRESS Restore_State = 2 // The restore operation has completed successfully. Restored workloads may // not yet be operational. Restore_SUCCEEDED Restore_State = 3 // The restore operation has failed. Restore_FAILED Restore_State = 4 // This Restore resource is in the process of being deleted. Restore_DELETING Restore_State = 5 )
func (Restore_State) Descriptor ¶
func (Restore_State) Descriptor() protoreflect.EnumDescriptor
func (Restore_State) Enum ¶
func (x Restore_State) Enum() *Restore_State
func (Restore_State) EnumDescriptor
deprecated
func (Restore_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Restore_State.Descriptor instead.
func (Restore_State) Number ¶
func (x Restore_State) Number() protoreflect.EnumNumber
func (Restore_State) String ¶
func (x Restore_State) String() string
func (Restore_State) Type ¶
func (Restore_State) Type() protoreflect.EnumType