Documentation
¶
Index ¶
- Constants
- Variables
- type Backup
- func (x *Backup) ClearAllNamespaces()
- func (x *Backup) ClearBackupScope()
- func (x *Backup) ClearClusterMetadata()
- func (x *Backup) ClearCompleteTime()
- func (x *Backup) ClearCreateTime()
- func (x *Backup) ClearDeleteLockExpireTime()
- func (x *Backup) ClearEncryptionKey()
- func (x *Backup) ClearRetainExpireTime()
- func (x *Backup) ClearSelectedApplications()
- func (x *Backup) ClearSelectedNamespaces()
- func (x *Backup) ClearUpdateTime()
- func (x *Backup) GetAllNamespaces() bool
- func (x *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 (x *Backup) HasAllNamespaces() bool
- func (x *Backup) HasBackupScope() bool
- func (x *Backup) HasClusterMetadata() bool
- func (x *Backup) HasCompleteTime() bool
- func (x *Backup) HasCreateTime() bool
- func (x *Backup) HasDeleteLockExpireTime() bool
- func (x *Backup) HasEncryptionKey() bool
- func (x *Backup) HasRetainExpireTime() bool
- func (x *Backup) HasSelectedApplications() bool
- func (x *Backup) HasSelectedNamespaces() bool
- func (x *Backup) HasUpdateTime() bool
- func (*Backup) ProtoMessage()
- func (x *Backup) ProtoReflect() protoreflect.Message
- func (x *Backup) Reset()
- func (x *Backup) SetAllNamespaces(v bool)
- func (x *Backup) SetClusterMetadata(v *Backup_ClusterMetadata)
- func (x *Backup) SetCompleteTime(v *timestamppb.Timestamp)
- func (x *Backup) SetConfigBackupSizeBytes(v int64)
- func (x *Backup) SetContainsSecrets(v bool)
- func (x *Backup) SetContainsVolumeData(v bool)
- func (x *Backup) SetCreateTime(v *timestamppb.Timestamp)
- func (x *Backup) SetDeleteLockDays(v int32)
- func (x *Backup) SetDeleteLockExpireTime(v *timestamppb.Timestamp)
- func (x *Backup) SetDescription(v string)
- func (x *Backup) SetEncryptionKey(v *EncryptionKey)
- func (x *Backup) SetEtag(v string)
- func (x *Backup) SetLabels(v map[string]string)
- func (x *Backup) SetManual(v bool)
- func (x *Backup) SetName(v string)
- func (x *Backup) SetPodCount(v int32)
- func (x *Backup) SetResourceCount(v int32)
- func (x *Backup) SetRetainDays(v int32)
- func (x *Backup) SetRetainExpireTime(v *timestamppb.Timestamp)
- func (x *Backup) SetSelectedApplications(v *NamespacedNames)
- func (x *Backup) SetSelectedNamespaces(v *Namespaces)
- func (x *Backup) SetSizeBytes(v int64)
- func (x *Backup) SetState(v Backup_State)
- func (x *Backup) SetStateReason(v string)
- func (x *Backup) SetUid(v string)
- func (x *Backup) SetUpdateTime(v *timestamppb.Timestamp)
- func (x *Backup) SetVolumeCount(v int32)
- func (x *Backup) String() string
- func (x *Backup) WhichBackupScope() case_Backup_BackupScope
- type BackupCreatedEvent
- func (x *BackupCreatedEvent) ClearData()
- func (x *BackupCreatedEvent) GetData() *BackupEventData
- func (x *BackupCreatedEvent) HasData() bool
- func (*BackupCreatedEvent) ProtoMessage()
- func (x *BackupCreatedEvent) ProtoReflect() protoreflect.Message
- func (x *BackupCreatedEvent) Reset()
- func (x *BackupCreatedEvent) SetData(v *BackupEventData)
- func (x *BackupCreatedEvent) String() string
- type BackupCreatedEvent_builder
- type BackupDeletedEvent
- func (x *BackupDeletedEvent) ClearData()
- func (x *BackupDeletedEvent) GetData() *BackupEventData
- func (x *BackupDeletedEvent) HasData() bool
- func (*BackupDeletedEvent) ProtoMessage()
- func (x *BackupDeletedEvent) ProtoReflect() protoreflect.Message
- func (x *BackupDeletedEvent) Reset()
- func (x *BackupDeletedEvent) SetData(v *BackupEventData)
- func (x *BackupDeletedEvent) String() string
- type BackupDeletedEvent_builder
- type BackupEventData
- func (x *BackupEventData) ClearPayload()
- func (x *BackupEventData) GetPayload() *Backup
- func (x *BackupEventData) HasPayload() bool
- func (*BackupEventData) ProtoMessage()
- func (x *BackupEventData) ProtoReflect() protoreflect.Message
- func (x *BackupEventData) Reset()
- func (x *BackupEventData) SetPayload(v *Backup)
- func (x *BackupEventData) String() string
- type BackupEventData_builder
- type BackupPlan
- func (x *BackupPlan) ClearBackupConfig()
- func (x *BackupPlan) ClearBackupSchedule()
- func (x *BackupPlan) ClearCreateTime()
- func (x *BackupPlan) ClearRetentionPolicy()
- func (x *BackupPlan) ClearUpdateTime()
- 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 (x *BackupPlan) HasBackupConfig() bool
- func (x *BackupPlan) HasBackupSchedule() bool
- func (x *BackupPlan) HasCreateTime() bool
- func (x *BackupPlan) HasRetentionPolicy() bool
- func (x *BackupPlan) HasUpdateTime() bool
- func (*BackupPlan) ProtoMessage()
- func (x *BackupPlan) ProtoReflect() protoreflect.Message
- func (x *BackupPlan) Reset()
- func (x *BackupPlan) SetBackupConfig(v *BackupPlan_BackupConfig)
- func (x *BackupPlan) SetBackupSchedule(v *BackupPlan_Schedule)
- func (x *BackupPlan) SetCluster(v string)
- func (x *BackupPlan) SetCreateTime(v *timestamppb.Timestamp)
- func (x *BackupPlan) SetDeactivated(v bool)
- func (x *BackupPlan) SetDescription(v string)
- func (x *BackupPlan) SetEtag(v string)
- func (x *BackupPlan) SetLabels(v map[string]string)
- func (x *BackupPlan) SetName(v string)
- func (x *BackupPlan) SetProtectedPodCount(v int32)
- func (x *BackupPlan) SetRetentionPolicy(v *BackupPlan_RetentionPolicy)
- func (x *BackupPlan) SetUid(v string)
- func (x *BackupPlan) SetUpdateTime(v *timestamppb.Timestamp)
- func (x *BackupPlan) String() string
- type BackupPlanCreatedEvent
- func (x *BackupPlanCreatedEvent) ClearData()
- func (x *BackupPlanCreatedEvent) GetData() *BackupPlanEventData
- func (x *BackupPlanCreatedEvent) HasData() bool
- func (*BackupPlanCreatedEvent) ProtoMessage()
- func (x *BackupPlanCreatedEvent) ProtoReflect() protoreflect.Message
- func (x *BackupPlanCreatedEvent) Reset()
- func (x *BackupPlanCreatedEvent) SetData(v *BackupPlanEventData)
- func (x *BackupPlanCreatedEvent) String() string
- type BackupPlanCreatedEvent_builder
- type BackupPlanDeletedEvent
- func (x *BackupPlanDeletedEvent) ClearData()
- func (x *BackupPlanDeletedEvent) GetData() *BackupPlanEventData
- func (x *BackupPlanDeletedEvent) HasData() bool
- func (*BackupPlanDeletedEvent) ProtoMessage()
- func (x *BackupPlanDeletedEvent) ProtoReflect() protoreflect.Message
- func (x *BackupPlanDeletedEvent) Reset()
- func (x *BackupPlanDeletedEvent) SetData(v *BackupPlanEventData)
- func (x *BackupPlanDeletedEvent) String() string
- type BackupPlanDeletedEvent_builder
- type BackupPlanEventData
- func (x *BackupPlanEventData) ClearPayload()
- func (x *BackupPlanEventData) GetPayload() *BackupPlan
- func (x *BackupPlanEventData) HasPayload() bool
- func (*BackupPlanEventData) ProtoMessage()
- func (x *BackupPlanEventData) ProtoReflect() protoreflect.Message
- func (x *BackupPlanEventData) Reset()
- func (x *BackupPlanEventData) SetPayload(v *BackupPlan)
- func (x *BackupPlanEventData) String() string
- type BackupPlanEventData_builder
- type BackupPlanUpdatedEvent
- func (x *BackupPlanUpdatedEvent) ClearData()
- func (x *BackupPlanUpdatedEvent) GetData() *BackupPlanEventData
- func (x *BackupPlanUpdatedEvent) HasData() bool
- func (*BackupPlanUpdatedEvent) ProtoMessage()
- func (x *BackupPlanUpdatedEvent) ProtoReflect() protoreflect.Message
- func (x *BackupPlanUpdatedEvent) Reset()
- func (x *BackupPlanUpdatedEvent) SetData(v *BackupPlanEventData)
- func (x *BackupPlanUpdatedEvent) String() string
- type BackupPlanUpdatedEvent_builder
- type BackupPlan_BackupConfig
- func (x *BackupPlan_BackupConfig) ClearAllNamespaces()
- func (x *BackupPlan_BackupConfig) ClearBackupScope()
- func (x *BackupPlan_BackupConfig) ClearEncryptionKey()
- func (x *BackupPlan_BackupConfig) ClearSelectedApplications()
- func (x *BackupPlan_BackupConfig) ClearSelectedNamespaces()
- func (x *BackupPlan_BackupConfig) GetAllNamespaces() bool
- func (x *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 (x *BackupPlan_BackupConfig) HasAllNamespaces() bool
- func (x *BackupPlan_BackupConfig) HasBackupScope() bool
- func (x *BackupPlan_BackupConfig) HasEncryptionKey() bool
- func (x *BackupPlan_BackupConfig) HasSelectedApplications() bool
- func (x *BackupPlan_BackupConfig) HasSelectedNamespaces() bool
- func (*BackupPlan_BackupConfig) ProtoMessage()
- func (x *BackupPlan_BackupConfig) ProtoReflect() protoreflect.Message
- func (x *BackupPlan_BackupConfig) Reset()
- func (x *BackupPlan_BackupConfig) SetAllNamespaces(v bool)
- func (x *BackupPlan_BackupConfig) SetEncryptionKey(v *EncryptionKey)
- func (x *BackupPlan_BackupConfig) SetIncludeSecrets(v bool)
- func (x *BackupPlan_BackupConfig) SetIncludeVolumeData(v bool)
- func (x *BackupPlan_BackupConfig) SetSelectedApplications(v *NamespacedNames)
- func (x *BackupPlan_BackupConfig) SetSelectedNamespaces(v *Namespaces)
- func (x *BackupPlan_BackupConfig) String() string
- func (x *BackupPlan_BackupConfig) WhichBackupScope() case_BackupPlan_BackupConfig_BackupScope
- type BackupPlan_BackupConfig_AllNamespaces
- type BackupPlan_BackupConfig_SelectedApplications
- type BackupPlan_BackupConfig_SelectedNamespaces
- type BackupPlan_BackupConfig_builder
- type BackupPlan_RetentionPolicy
- 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) SetBackupDeleteLockDays(v int32)
- func (x *BackupPlan_RetentionPolicy) SetBackupRetainDays(v int32)
- func (x *BackupPlan_RetentionPolicy) SetLocked(v bool)
- func (x *BackupPlan_RetentionPolicy) String() string
- type BackupPlan_RetentionPolicy_builder
- type BackupPlan_Schedule
- 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) SetCronSchedule(v string)
- func (x *BackupPlan_Schedule) SetPaused(v bool)
- func (x *BackupPlan_Schedule) String() string
- type BackupPlan_Schedule_builder
- type BackupPlan_builder
- type BackupUpdatedEvent
- func (x *BackupUpdatedEvent) ClearData()
- func (x *BackupUpdatedEvent) GetData() *BackupEventData
- func (x *BackupUpdatedEvent) HasData() bool
- func (*BackupUpdatedEvent) ProtoMessage()
- func (x *BackupUpdatedEvent) ProtoReflect() protoreflect.Message
- func (x *BackupUpdatedEvent) Reset()
- func (x *BackupUpdatedEvent) SetData(v *BackupEventData)
- func (x *BackupUpdatedEvent) String() string
- type BackupUpdatedEvent_builder
- type Backup_AllNamespaces
- type Backup_ClusterMetadata
- func (x *Backup_ClusterMetadata) ClearAnthosVersion()
- func (x *Backup_ClusterMetadata) ClearGkeVersion()
- func (x *Backup_ClusterMetadata) ClearPlatformVersion()
- 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 (x *Backup_ClusterMetadata) GetPlatformVersion() isBackup_ClusterMetadata_PlatformVersion
- func (x *Backup_ClusterMetadata) HasAnthosVersion() bool
- func (x *Backup_ClusterMetadata) HasGkeVersion() bool
- func (x *Backup_ClusterMetadata) HasPlatformVersion() bool
- func (*Backup_ClusterMetadata) ProtoMessage()
- func (x *Backup_ClusterMetadata) ProtoReflect() protoreflect.Message
- func (x *Backup_ClusterMetadata) Reset()
- func (x *Backup_ClusterMetadata) SetAnthosVersion(v string)
- func (x *Backup_ClusterMetadata) SetBackupCrdVersions(v map[string]string)
- func (x *Backup_ClusterMetadata) SetCluster(v string)
- func (x *Backup_ClusterMetadata) SetGkeVersion(v string)
- func (x *Backup_ClusterMetadata) SetK8SVersion(v string)
- func (x *Backup_ClusterMetadata) String() string
- func (x *Backup_ClusterMetadata) WhichPlatformVersion() case_Backup_ClusterMetadata_PlatformVersion
- type Backup_ClusterMetadata_AnthosVersion
- type Backup_ClusterMetadata_GkeVersion
- type Backup_ClusterMetadata_builder
- type Backup_SelectedApplications
- type Backup_SelectedNamespaces
- type Backup_State
- type Backup_builder
- type EncryptionKey
- type EncryptionKey_builder
- type NamespacedName
- 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) SetName(v string)
- func (x *NamespacedName) SetNamespace(v string)
- func (x *NamespacedName) String() string
- type NamespacedName_builder
- type NamespacedNames
- func (x *NamespacedNames) GetNamespacedNames() []*NamespacedName
- func (*NamespacedNames) ProtoMessage()
- func (x *NamespacedNames) ProtoReflect() protoreflect.Message
- func (x *NamespacedNames) Reset()
- func (x *NamespacedNames) SetNamespacedNames(v []*NamespacedName)
- func (x *NamespacedNames) String() string
- type NamespacedNames_builder
- type Namespaces
- type Namespaces_builder
- type Restore
- func (x *Restore) ClearCompleteTime()
- func (x *Restore) ClearCreateTime()
- func (x *Restore) ClearRestoreConfig()
- func (x *Restore) ClearUpdateTime()
- 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 (x *Restore) HasCompleteTime() bool
- func (x *Restore) HasCreateTime() bool
- func (x *Restore) HasRestoreConfig() bool
- func (x *Restore) HasUpdateTime() bool
- func (*Restore) ProtoMessage()
- func (x *Restore) ProtoReflect() protoreflect.Message
- func (x *Restore) Reset()
- func (x *Restore) SetBackup(v string)
- func (x *Restore) SetCluster(v string)
- func (x *Restore) SetCompleteTime(v *timestamppb.Timestamp)
- func (x *Restore) SetCreateTime(v *timestamppb.Timestamp)
- func (x *Restore) SetDescription(v string)
- func (x *Restore) SetEtag(v string)
- func (x *Restore) SetLabels(v map[string]string)
- func (x *Restore) SetName(v string)
- func (x *Restore) SetResourcesExcludedCount(v int32)
- func (x *Restore) SetResourcesFailedCount(v int32)
- func (x *Restore) SetResourcesRestoredCount(v int32)
- func (x *Restore) SetRestoreConfig(v *RestoreConfig)
- func (x *Restore) SetState(v Restore_State)
- func (x *Restore) SetStateReason(v string)
- func (x *Restore) SetUid(v string)
- func (x *Restore) SetUpdateTime(v *timestamppb.Timestamp)
- func (x *Restore) SetVolumesRestoredCount(v int32)
- func (x *Restore) String() string
- type RestoreConfig
- func (x *RestoreConfig) ClearAllNamespaces()
- func (x *RestoreConfig) ClearClusterResourceRestoreScope()
- func (x *RestoreConfig) ClearNamespacedResourceRestoreScope()
- func (x *RestoreConfig) ClearSelectedApplications()
- func (x *RestoreConfig) ClearSelectedNamespaces()
- func (x *RestoreConfig) GetAllNamespaces() bool
- func (x *RestoreConfig) GetClusterResourceConflictPolicy() RestoreConfig_ClusterResourceConflictPolicy
- func (x *RestoreConfig) GetClusterResourceRestoreScope() *RestoreConfig_ClusterResourceRestoreScope
- func (x *RestoreConfig) GetNamespacedResourceRestoreMode() RestoreConfig_NamespacedResourceRestoreMode
- func (x *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 (x *RestoreConfig) HasAllNamespaces() bool
- func (x *RestoreConfig) HasClusterResourceRestoreScope() bool
- func (x *RestoreConfig) HasNamespacedResourceRestoreScope() bool
- func (x *RestoreConfig) HasSelectedApplications() bool
- func (x *RestoreConfig) HasSelectedNamespaces() bool
- func (*RestoreConfig) ProtoMessage()
- func (x *RestoreConfig) ProtoReflect() protoreflect.Message
- func (x *RestoreConfig) Reset()
- func (x *RestoreConfig) SetAllNamespaces(v bool)
- func (x *RestoreConfig) SetClusterResourceConflictPolicy(v RestoreConfig_ClusterResourceConflictPolicy)
- func (x *RestoreConfig) SetClusterResourceRestoreScope(v *RestoreConfig_ClusterResourceRestoreScope)
- func (x *RestoreConfig) SetNamespacedResourceRestoreMode(v RestoreConfig_NamespacedResourceRestoreMode)
- func (x *RestoreConfig) SetSelectedApplications(v *NamespacedNames)
- func (x *RestoreConfig) SetSelectedNamespaces(v *Namespaces)
- func (x *RestoreConfig) SetSubstitutionRules(v []*RestoreConfig_SubstitutionRule)
- func (x *RestoreConfig) SetVolumeDataRestorePolicy(v RestoreConfig_VolumeDataRestorePolicy)
- func (x *RestoreConfig) String() string
- func (x *RestoreConfig) WhichNamespacedResourceRestoreScope() case_RestoreConfig_NamespacedResourceRestoreScope
- type RestoreConfig_AllNamespaces
- type RestoreConfig_ClusterResourceConflictPolicy
- func (RestoreConfig_ClusterResourceConflictPolicy) Descriptor() protoreflect.EnumDescriptor
- func (x RestoreConfig_ClusterResourceConflictPolicy) Enum() *RestoreConfig_ClusterResourceConflictPolicy
- func (x RestoreConfig_ClusterResourceConflictPolicy) Number() protoreflect.EnumNumber
- func (x RestoreConfig_ClusterResourceConflictPolicy) String() string
- func (RestoreConfig_ClusterResourceConflictPolicy) Type() protoreflect.EnumType
- type RestoreConfig_ClusterResourceRestoreScope
- 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) SetSelectedGroupKinds(v []*RestoreConfig_GroupKind)
- func (x *RestoreConfig_ClusterResourceRestoreScope) String() string
- type RestoreConfig_ClusterResourceRestoreScope_builder
- type RestoreConfig_GroupKind
- 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) SetResourceGroup(v string)
- func (x *RestoreConfig_GroupKind) SetResourceKind(v string)
- func (x *RestoreConfig_GroupKind) String() string
- type RestoreConfig_GroupKind_builder
- type RestoreConfig_NamespacedResourceRestoreMode
- func (RestoreConfig_NamespacedResourceRestoreMode) Descriptor() protoreflect.EnumDescriptor
- func (x RestoreConfig_NamespacedResourceRestoreMode) Enum() *RestoreConfig_NamespacedResourceRestoreMode
- 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 (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) SetNewValue(v string)
- func (x *RestoreConfig_SubstitutionRule) SetOriginalValuePattern(v string)
- func (x *RestoreConfig_SubstitutionRule) SetTargetGroupKinds(v []*RestoreConfig_GroupKind)
- func (x *RestoreConfig_SubstitutionRule) SetTargetJsonPath(v string)
- func (x *RestoreConfig_SubstitutionRule) SetTargetNamespaces(v []string)
- func (x *RestoreConfig_SubstitutionRule) String() string
- type RestoreConfig_SubstitutionRule_builder
- type RestoreConfig_VolumeDataRestorePolicy
- func (RestoreConfig_VolumeDataRestorePolicy) Descriptor() protoreflect.EnumDescriptor
- func (x RestoreConfig_VolumeDataRestorePolicy) Enum() *RestoreConfig_VolumeDataRestorePolicy
- func (x RestoreConfig_VolumeDataRestorePolicy) Number() protoreflect.EnumNumber
- func (x RestoreConfig_VolumeDataRestorePolicy) String() string
- func (RestoreConfig_VolumeDataRestorePolicy) Type() protoreflect.EnumType
- type RestoreConfig_builder
- type RestoreCreatedEvent
- func (x *RestoreCreatedEvent) ClearData()
- func (x *RestoreCreatedEvent) GetData() *RestoreEventData
- func (x *RestoreCreatedEvent) HasData() bool
- func (*RestoreCreatedEvent) ProtoMessage()
- func (x *RestoreCreatedEvent) ProtoReflect() protoreflect.Message
- func (x *RestoreCreatedEvent) Reset()
- func (x *RestoreCreatedEvent) SetData(v *RestoreEventData)
- func (x *RestoreCreatedEvent) String() string
- type RestoreCreatedEvent_builder
- type RestoreDeletedEvent
- func (x *RestoreDeletedEvent) ClearData()
- func (x *RestoreDeletedEvent) GetData() *RestoreEventData
- func (x *RestoreDeletedEvent) HasData() bool
- func (*RestoreDeletedEvent) ProtoMessage()
- func (x *RestoreDeletedEvent) ProtoReflect() protoreflect.Message
- func (x *RestoreDeletedEvent) Reset()
- func (x *RestoreDeletedEvent) SetData(v *RestoreEventData)
- func (x *RestoreDeletedEvent) String() string
- type RestoreDeletedEvent_builder
- type RestoreEventData
- func (x *RestoreEventData) ClearPayload()
- func (x *RestoreEventData) GetPayload() *Restore
- func (x *RestoreEventData) HasPayload() bool
- func (*RestoreEventData) ProtoMessage()
- func (x *RestoreEventData) ProtoReflect() protoreflect.Message
- func (x *RestoreEventData) Reset()
- func (x *RestoreEventData) SetPayload(v *Restore)
- func (x *RestoreEventData) String() string
- type RestoreEventData_builder
- type RestorePlan
- func (x *RestorePlan) ClearCreateTime()
- func (x *RestorePlan) ClearRestoreConfig()
- func (x *RestorePlan) ClearUpdateTime()
- 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 (x *RestorePlan) HasCreateTime() bool
- func (x *RestorePlan) HasRestoreConfig() bool
- func (x *RestorePlan) HasUpdateTime() bool
- func (*RestorePlan) ProtoMessage()
- func (x *RestorePlan) ProtoReflect() protoreflect.Message
- func (x *RestorePlan) Reset()
- func (x *RestorePlan) SetBackupPlan(v string)
- func (x *RestorePlan) SetCluster(v string)
- func (x *RestorePlan) SetCreateTime(v *timestamppb.Timestamp)
- func (x *RestorePlan) SetDescription(v string)
- func (x *RestorePlan) SetEtag(v string)
- func (x *RestorePlan) SetLabels(v map[string]string)
- func (x *RestorePlan) SetName(v string)
- func (x *RestorePlan) SetRestoreConfig(v *RestoreConfig)
- func (x *RestorePlan) SetUid(v string)
- func (x *RestorePlan) SetUpdateTime(v *timestamppb.Timestamp)
- func (x *RestorePlan) String() string
- type RestorePlanCreatedEvent
- func (x *RestorePlanCreatedEvent) ClearData()
- func (x *RestorePlanCreatedEvent) GetData() *RestorePlanEventData
- func (x *RestorePlanCreatedEvent) HasData() bool
- func (*RestorePlanCreatedEvent) ProtoMessage()
- func (x *RestorePlanCreatedEvent) ProtoReflect() protoreflect.Message
- func (x *RestorePlanCreatedEvent) Reset()
- func (x *RestorePlanCreatedEvent) SetData(v *RestorePlanEventData)
- func (x *RestorePlanCreatedEvent) String() string
- type RestorePlanCreatedEvent_builder
- type RestorePlanDeletedEvent
- func (x *RestorePlanDeletedEvent) ClearData()
- func (x *RestorePlanDeletedEvent) GetData() *RestorePlanEventData
- func (x *RestorePlanDeletedEvent) HasData() bool
- func (*RestorePlanDeletedEvent) ProtoMessage()
- func (x *RestorePlanDeletedEvent) ProtoReflect() protoreflect.Message
- func (x *RestorePlanDeletedEvent) Reset()
- func (x *RestorePlanDeletedEvent) SetData(v *RestorePlanEventData)
- func (x *RestorePlanDeletedEvent) String() string
- type RestorePlanDeletedEvent_builder
- type RestorePlanEventData
- func (x *RestorePlanEventData) ClearPayload()
- func (x *RestorePlanEventData) GetPayload() *RestorePlan
- func (x *RestorePlanEventData) HasPayload() bool
- func (*RestorePlanEventData) ProtoMessage()
- func (x *RestorePlanEventData) ProtoReflect() protoreflect.Message
- func (x *RestorePlanEventData) Reset()
- func (x *RestorePlanEventData) SetPayload(v *RestorePlan)
- func (x *RestorePlanEventData) String() string
- type RestorePlanEventData_builder
- type RestorePlanUpdatedEvent
- func (x *RestorePlanUpdatedEvent) ClearData()
- func (x *RestorePlanUpdatedEvent) GetData() *RestorePlanEventData
- func (x *RestorePlanUpdatedEvent) HasData() bool
- func (*RestorePlanUpdatedEvent) ProtoMessage()
- func (x *RestorePlanUpdatedEvent) ProtoReflect() protoreflect.Message
- func (x *RestorePlanUpdatedEvent) Reset()
- func (x *RestorePlanUpdatedEvent) SetData(v *RestorePlanEventData)
- func (x *RestorePlanUpdatedEvent) String() string
- type RestorePlanUpdatedEvent_builder
- type RestorePlan_builder
- type RestoreUpdatedEvent
- func (x *RestoreUpdatedEvent) ClearData()
- func (x *RestoreUpdatedEvent) GetData() *RestoreEventData
- func (x *RestoreUpdatedEvent) HasData() bool
- func (*RestoreUpdatedEvent) ProtoMessage()
- func (x *RestoreUpdatedEvent) ProtoReflect() protoreflect.Message
- func (x *RestoreUpdatedEvent) Reset()
- func (x *RestoreUpdatedEvent) SetData(v *RestoreEventData)
- func (x *RestoreUpdatedEvent) String() string
- type RestoreUpdatedEvent_builder
- type Restore_State
- type Restore_builder
Constants ¶
const BackupPlan_BackupConfig_AllNamespaces_case case_BackupPlan_BackupConfig_BackupScope = 1
const BackupPlan_BackupConfig_BackupScope_not_set_case case_BackupPlan_BackupConfig_BackupScope = 0
const BackupPlan_BackupConfig_SelectedApplications_case case_BackupPlan_BackupConfig_BackupScope = 3
const BackupPlan_BackupConfig_SelectedNamespaces_case case_BackupPlan_BackupConfig_BackupScope = 2
const Backup_AllNamespaces_case case_Backup_BackupScope = 12
const Backup_BackupScope_not_set_case case_Backup_BackupScope = 0
const Backup_ClusterMetadata_AnthosVersion_case case_Backup_ClusterMetadata_PlatformVersion = 5
const Backup_ClusterMetadata_GkeVersion_case case_Backup_ClusterMetadata_PlatformVersion = 4
const Backup_ClusterMetadata_PlatformVersion_not_set_case case_Backup_ClusterMetadata_PlatformVersion = 0
const Backup_SelectedApplications_case case_Backup_BackupScope = 14
const Backup_SelectedNamespaces_case case_Backup_BackupScope = 13
const RestoreConfig_AllNamespaces_case case_RestoreConfig_NamespacedResourceRestoreScope = 5
const RestoreConfig_NamespacedResourceRestoreScope_not_set_case case_RestoreConfig_NamespacedResourceRestoreScope = 0
const RestoreConfig_SelectedApplications_case case_RestoreConfig_NamespacedResourceRestoreScope = 7
const RestoreConfig_SelectedNamespaces_case case_RestoreConfig_NamespacedResourceRestoreScope = 6
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_google_events_cloud_gkebackup_v1_data_proto protoreflect.FileDescriptor
var File_google_events_cloud_gkebackup_v1_events_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 `` /* 139-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 valid to be assigned 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) GetClusterMetadata ¶
func (x *Backup) GetClusterMetadata() *Backup_ClusterMetadata
func (*Backup) GetCompleteTime ¶
func (x *Backup) GetCompleteTime() *timestamppb.Timestamp
func (*Backup) GetCreateTime ¶
func (x *Backup) GetCreateTime() *timestamppb.Timestamp
func (*Backup) GetDeleteLockExpireTime ¶
func (x *Backup) GetDeleteLockExpireTime() *timestamppb.Timestamp
func (*Backup) GetEncryptionKey ¶
func (x *Backup) GetEncryptionKey() *EncryptionKey
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) GetState ¶
func (x *Backup) GetState() Backup_State
func (*Backup) GetUpdateTime ¶
func (x *Backup) GetUpdateTime() *timestamppb.Timestamp
func (*Backup) ProtoReflect ¶
func (x *Backup) ProtoReflect() protoreflect.Message
func (*Backup) SetClusterMetadata ¶
func (x *Backup) SetClusterMetadata(v *Backup_ClusterMetadata)
func (*Backup) SetCompleteTime ¶
func (x *Backup) SetCompleteTime(v *timestamppb.Timestamp)
func (*Backup) SetCreateTime ¶
func (x *Backup) SetCreateTime(v *timestamppb.Timestamp)
func (*Backup) SetDeleteLockExpireTime ¶
func (x *Backup) SetDeleteLockExpireTime(v *timestamppb.Timestamp)
func (*Backup) SetEncryptionKey ¶
func (x *Backup) SetEncryptionKey(v *EncryptionKey)
func (*Backup) SetRetainExpireTime ¶
func (x *Backup) SetRetainExpireTime(v *timestamppb.Timestamp)
func (*Backup) SetSelectedApplications ¶
func (x *Backup) SetSelectedApplications(v *NamespacedNames)
func (*Backup) SetSelectedNamespaces ¶
func (x *Backup) SetSelectedNamespaces(v *Namespaces)
func (*Backup) SetState ¶
func (x *Backup) SetState(v Backup_State)
func (*Backup) SetUpdateTime ¶
func (x *Backup) SetUpdateTime(v *timestamppb.Timestamp)
type BackupCreatedEvent ¶
type BackupCreatedEvent struct {
// The data associated with the event.
Data *BackupEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a Backup is created.
func (*BackupCreatedEvent) ClearData ¶
func (x *BackupCreatedEvent) ClearData()
func (*BackupCreatedEvent) GetData ¶
func (x *BackupCreatedEvent) GetData() *BackupEventData
func (*BackupCreatedEvent) HasData ¶
func (x *BackupCreatedEvent) HasData() bool
func (*BackupCreatedEvent) ProtoMessage ¶
func (*BackupCreatedEvent) ProtoMessage()
func (*BackupCreatedEvent) ProtoReflect ¶
func (x *BackupCreatedEvent) ProtoReflect() protoreflect.Message
func (*BackupCreatedEvent) Reset ¶
func (x *BackupCreatedEvent) Reset()
func (*BackupCreatedEvent) SetData ¶
func (x *BackupCreatedEvent) SetData(v *BackupEventData)
func (*BackupCreatedEvent) String ¶
func (x *BackupCreatedEvent) String() string
type BackupCreatedEvent_builder ¶
type BackupCreatedEvent_builder struct {
// The data associated with the event.
Data *BackupEventData
// contains filtered or unexported fields
}
func (BackupCreatedEvent_builder) Build ¶
func (b0 BackupCreatedEvent_builder) Build() *BackupCreatedEvent
type BackupDeletedEvent ¶
type BackupDeletedEvent struct {
// The data associated with the event.
Data *BackupEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a Backup is deleted.
func (*BackupDeletedEvent) ClearData ¶
func (x *BackupDeletedEvent) ClearData()
func (*BackupDeletedEvent) GetData ¶
func (x *BackupDeletedEvent) GetData() *BackupEventData
func (*BackupDeletedEvent) HasData ¶
func (x *BackupDeletedEvent) HasData() bool
func (*BackupDeletedEvent) ProtoMessage ¶
func (*BackupDeletedEvent) ProtoMessage()
func (*BackupDeletedEvent) ProtoReflect ¶
func (x *BackupDeletedEvent) ProtoReflect() protoreflect.Message
func (*BackupDeletedEvent) Reset ¶
func (x *BackupDeletedEvent) Reset()
func (*BackupDeletedEvent) SetData ¶
func (x *BackupDeletedEvent) SetData(v *BackupEventData)
func (*BackupDeletedEvent) String ¶
func (x *BackupDeletedEvent) String() string
type BackupDeletedEvent_builder ¶
type BackupDeletedEvent_builder struct {
// The data associated with the event.
Data *BackupEventData
// contains filtered or unexported fields
}
func (BackupDeletedEvent_builder) Build ¶
func (b0 BackupDeletedEvent_builder) Build() *BackupDeletedEvent
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) ClearPayload ¶
func (x *BackupEventData) ClearPayload()
func (*BackupEventData) GetPayload ¶
func (x *BackupEventData) GetPayload() *Backup
func (*BackupEventData) HasPayload ¶
func (x *BackupEventData) HasPayload() bool
func (*BackupEventData) ProtoMessage ¶
func (*BackupEventData) ProtoMessage()
func (*BackupEventData) ProtoReflect ¶
func (x *BackupEventData) ProtoReflect() protoreflect.Message
func (*BackupEventData) Reset ¶
func (x *BackupEventData) Reset()
func (*BackupEventData) SetPayload ¶
func (x *BackupEventData) SetPayload(v *Backup)
func (*BackupEventData) String ¶
func (x *BackupEventData) String() string
type BackupEventData_builder ¶
type BackupEventData_builder struct {
// Optional. The Backup event payload. Unset for deletion events.
Payload *Backup
// contains filtered or unexported fields
}
func (BackupEventData_builder) Build ¶
func (b0 BackupEventData_builder) Build() *BackupEventData
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 `` /* 139-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) ClearBackupConfig ¶
func (x *BackupPlan) ClearBackupConfig()
func (*BackupPlan) ClearBackupSchedule ¶
func (x *BackupPlan) ClearBackupSchedule()
func (*BackupPlan) ClearCreateTime ¶
func (x *BackupPlan) ClearCreateTime()
func (*BackupPlan) ClearRetentionPolicy ¶
func (x *BackupPlan) ClearRetentionPolicy()
func (*BackupPlan) ClearUpdateTime ¶
func (x *BackupPlan) ClearUpdateTime()
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) HasBackupConfig ¶
func (x *BackupPlan) HasBackupConfig() bool
func (*BackupPlan) HasBackupSchedule ¶
func (x *BackupPlan) HasBackupSchedule() bool
func (*BackupPlan) HasCreateTime ¶
func (x *BackupPlan) HasCreateTime() bool
func (*BackupPlan) HasRetentionPolicy ¶
func (x *BackupPlan) HasRetentionPolicy() bool
func (*BackupPlan) HasUpdateTime ¶
func (x *BackupPlan) HasUpdateTime() bool
func (*BackupPlan) ProtoMessage ¶
func (*BackupPlan) ProtoMessage()
func (*BackupPlan) ProtoReflect ¶
func (x *BackupPlan) ProtoReflect() protoreflect.Message
func (*BackupPlan) Reset ¶
func (x *BackupPlan) Reset()
func (*BackupPlan) SetBackupConfig ¶
func (x *BackupPlan) SetBackupConfig(v *BackupPlan_BackupConfig)
func (*BackupPlan) SetBackupSchedule ¶
func (x *BackupPlan) SetBackupSchedule(v *BackupPlan_Schedule)
func (*BackupPlan) SetCluster ¶
func (x *BackupPlan) SetCluster(v string)
func (*BackupPlan) SetCreateTime ¶
func (x *BackupPlan) SetCreateTime(v *timestamppb.Timestamp)
func (*BackupPlan) SetDeactivated ¶
func (x *BackupPlan) SetDeactivated(v bool)
func (*BackupPlan) SetDescription ¶
func (x *BackupPlan) SetDescription(v string)
func (*BackupPlan) SetEtag ¶
func (x *BackupPlan) SetEtag(v string)
func (*BackupPlan) SetLabels ¶
func (x *BackupPlan) SetLabels(v map[string]string)
func (*BackupPlan) SetName ¶
func (x *BackupPlan) SetName(v string)
func (*BackupPlan) SetProtectedPodCount ¶
func (x *BackupPlan) SetProtectedPodCount(v int32)
func (*BackupPlan) SetRetentionPolicy ¶
func (x *BackupPlan) SetRetentionPolicy(v *BackupPlan_RetentionPolicy)
func (*BackupPlan) SetUid ¶
func (x *BackupPlan) SetUid(v string)
func (*BackupPlan) SetUpdateTime ¶
func (x *BackupPlan) SetUpdateTime(v *timestamppb.Timestamp)
func (*BackupPlan) String ¶
func (x *BackupPlan) String() string
type BackupPlanCreatedEvent ¶
type BackupPlanCreatedEvent struct {
// The data associated with the event.
Data *BackupPlanEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a BackupPlan is created.
func (*BackupPlanCreatedEvent) ClearData ¶
func (x *BackupPlanCreatedEvent) ClearData()
func (*BackupPlanCreatedEvent) GetData ¶
func (x *BackupPlanCreatedEvent) GetData() *BackupPlanEventData
func (*BackupPlanCreatedEvent) HasData ¶
func (x *BackupPlanCreatedEvent) HasData() bool
func (*BackupPlanCreatedEvent) ProtoMessage ¶
func (*BackupPlanCreatedEvent) ProtoMessage()
func (*BackupPlanCreatedEvent) ProtoReflect ¶
func (x *BackupPlanCreatedEvent) ProtoReflect() protoreflect.Message
func (*BackupPlanCreatedEvent) Reset ¶
func (x *BackupPlanCreatedEvent) Reset()
func (*BackupPlanCreatedEvent) SetData ¶
func (x *BackupPlanCreatedEvent) SetData(v *BackupPlanEventData)
func (*BackupPlanCreatedEvent) String ¶
func (x *BackupPlanCreatedEvent) String() string
type BackupPlanCreatedEvent_builder ¶
type BackupPlanCreatedEvent_builder struct {
// The data associated with the event.
Data *BackupPlanEventData
// contains filtered or unexported fields
}
func (BackupPlanCreatedEvent_builder) Build ¶
func (b0 BackupPlanCreatedEvent_builder) Build() *BackupPlanCreatedEvent
type BackupPlanDeletedEvent ¶
type BackupPlanDeletedEvent struct {
// The data associated with the event.
Data *BackupPlanEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a BackupPlan is deleted.
func (*BackupPlanDeletedEvent) ClearData ¶
func (x *BackupPlanDeletedEvent) ClearData()
func (*BackupPlanDeletedEvent) GetData ¶
func (x *BackupPlanDeletedEvent) GetData() *BackupPlanEventData
func (*BackupPlanDeletedEvent) HasData ¶
func (x *BackupPlanDeletedEvent) HasData() bool
func (*BackupPlanDeletedEvent) ProtoMessage ¶
func (*BackupPlanDeletedEvent) ProtoMessage()
func (*BackupPlanDeletedEvent) ProtoReflect ¶
func (x *BackupPlanDeletedEvent) ProtoReflect() protoreflect.Message
func (*BackupPlanDeletedEvent) Reset ¶
func (x *BackupPlanDeletedEvent) Reset()
func (*BackupPlanDeletedEvent) SetData ¶
func (x *BackupPlanDeletedEvent) SetData(v *BackupPlanEventData)
func (*BackupPlanDeletedEvent) String ¶
func (x *BackupPlanDeletedEvent) String() string
type BackupPlanDeletedEvent_builder ¶
type BackupPlanDeletedEvent_builder struct {
// The data associated with the event.
Data *BackupPlanEventData
// contains filtered or unexported fields
}
func (BackupPlanDeletedEvent_builder) Build ¶
func (b0 BackupPlanDeletedEvent_builder) Build() *BackupPlanDeletedEvent
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) ClearPayload ¶
func (x *BackupPlanEventData) ClearPayload()
func (*BackupPlanEventData) GetPayload ¶
func (x *BackupPlanEventData) GetPayload() *BackupPlan
func (*BackupPlanEventData) HasPayload ¶
func (x *BackupPlanEventData) HasPayload() bool
func (*BackupPlanEventData) ProtoMessage ¶
func (*BackupPlanEventData) ProtoMessage()
func (*BackupPlanEventData) ProtoReflect ¶
func (x *BackupPlanEventData) ProtoReflect() protoreflect.Message
func (*BackupPlanEventData) Reset ¶
func (x *BackupPlanEventData) Reset()
func (*BackupPlanEventData) SetPayload ¶
func (x *BackupPlanEventData) SetPayload(v *BackupPlan)
func (*BackupPlanEventData) String ¶
func (x *BackupPlanEventData) String() string
type BackupPlanEventData_builder ¶
type BackupPlanEventData_builder struct {
// Optional. The BackupPlan event payload. Unset for deletion events.
Payload *BackupPlan
// contains filtered or unexported fields
}
func (BackupPlanEventData_builder) Build ¶
func (b0 BackupPlanEventData_builder) Build() *BackupPlanEventData
type BackupPlanUpdatedEvent ¶
type BackupPlanUpdatedEvent struct {
// The data associated with the event.
Data *BackupPlanEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a BackupPlan is updated.
func (*BackupPlanUpdatedEvent) ClearData ¶
func (x *BackupPlanUpdatedEvent) ClearData()
func (*BackupPlanUpdatedEvent) GetData ¶
func (x *BackupPlanUpdatedEvent) GetData() *BackupPlanEventData
func (*BackupPlanUpdatedEvent) HasData ¶
func (x *BackupPlanUpdatedEvent) HasData() bool
func (*BackupPlanUpdatedEvent) ProtoMessage ¶
func (*BackupPlanUpdatedEvent) ProtoMessage()
func (*BackupPlanUpdatedEvent) ProtoReflect ¶
func (x *BackupPlanUpdatedEvent) ProtoReflect() protoreflect.Message
func (*BackupPlanUpdatedEvent) Reset ¶
func (x *BackupPlanUpdatedEvent) Reset()
func (*BackupPlanUpdatedEvent) SetData ¶
func (x *BackupPlanUpdatedEvent) SetData(v *BackupPlanEventData)
func (*BackupPlanUpdatedEvent) String ¶
func (x *BackupPlanUpdatedEvent) String() string
type BackupPlanUpdatedEvent_builder ¶
type BackupPlanUpdatedEvent_builder struct {
// The data associated with the event.
Data *BackupPlanEventData
// contains filtered or unexported fields
}
func (BackupPlanUpdatedEvent_builder) Build ¶
func (b0 BackupPlanUpdatedEvent_builder) Build() *BackupPlanUpdatedEvent
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 valid to be assigned 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) ClearAllNamespaces ¶
func (x *BackupPlan_BackupConfig) ClearAllNamespaces()
func (*BackupPlan_BackupConfig) ClearBackupScope ¶
func (x *BackupPlan_BackupConfig) ClearBackupScope()
func (*BackupPlan_BackupConfig) ClearEncryptionKey ¶
func (x *BackupPlan_BackupConfig) ClearEncryptionKey()
func (*BackupPlan_BackupConfig) ClearSelectedApplications ¶
func (x *BackupPlan_BackupConfig) ClearSelectedApplications()
func (*BackupPlan_BackupConfig) ClearSelectedNamespaces ¶
func (x *BackupPlan_BackupConfig) ClearSelectedNamespaces()
func (*BackupPlan_BackupConfig) GetAllNamespaces ¶
func (x *BackupPlan_BackupConfig) GetAllNamespaces() bool
func (*BackupPlan_BackupConfig) GetBackupScope ¶
func (x *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) HasAllNamespaces ¶
func (x *BackupPlan_BackupConfig) HasAllNamespaces() bool
func (*BackupPlan_BackupConfig) HasBackupScope ¶
func (x *BackupPlan_BackupConfig) HasBackupScope() bool
func (*BackupPlan_BackupConfig) HasEncryptionKey ¶
func (x *BackupPlan_BackupConfig) HasEncryptionKey() bool
func (*BackupPlan_BackupConfig) HasSelectedApplications ¶
func (x *BackupPlan_BackupConfig) HasSelectedApplications() bool
func (*BackupPlan_BackupConfig) HasSelectedNamespaces ¶
func (x *BackupPlan_BackupConfig) HasSelectedNamespaces() bool
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) SetAllNamespaces ¶
func (x *BackupPlan_BackupConfig) SetAllNamespaces(v bool)
func (*BackupPlan_BackupConfig) SetEncryptionKey ¶
func (x *BackupPlan_BackupConfig) SetEncryptionKey(v *EncryptionKey)
func (*BackupPlan_BackupConfig) SetIncludeSecrets ¶
func (x *BackupPlan_BackupConfig) SetIncludeSecrets(v bool)
func (*BackupPlan_BackupConfig) SetIncludeVolumeData ¶
func (x *BackupPlan_BackupConfig) SetIncludeVolumeData(v bool)
func (*BackupPlan_BackupConfig) SetSelectedApplications ¶
func (x *BackupPlan_BackupConfig) SetSelectedApplications(v *NamespacedNames)
func (*BackupPlan_BackupConfig) SetSelectedNamespaces ¶
func (x *BackupPlan_BackupConfig) SetSelectedNamespaces(v *Namespaces)
func (*BackupPlan_BackupConfig) String ¶
func (x *BackupPlan_BackupConfig) String() string
func (*BackupPlan_BackupConfig) WhichBackupScope ¶
func (x *BackupPlan_BackupConfig) WhichBackupScope() case_BackupPlan_BackupConfig_BackupScope
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_BackupConfig_builder ¶
type BackupPlan_BackupConfig_builder struct {
// Fields of oneof BackupScope:
// If True, include all namespaced resources
AllNamespaces *bool
// If set, include just the resources in the listed namespaces.
SelectedNamespaces *Namespaces
// If set, include just the resources referenced by the listed
// ProtectedApplications.
SelectedApplications *NamespacedNames
// -- end of BackupScope
// This flag specifies whether volume data should be backed up when
// PVCs are included in the scope of a Backup.
//
// Default: False
IncludeVolumeData bool
// This flag specifies whether Kubernetes Secret resources should be
// included when they fall into the scope of Backups.
//
// Default: False
IncludeSecrets bool
// 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
// contains filtered or unexported fields
}
func (BackupPlan_BackupConfig_builder) Build ¶
func (b0 BackupPlan_BackupConfig_builder) Build() *BackupPlan_BackupConfig
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) 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) SetBackupDeleteLockDays ¶
func (x *BackupPlan_RetentionPolicy) SetBackupDeleteLockDays(v int32)
func (*BackupPlan_RetentionPolicy) SetBackupRetainDays ¶
func (x *BackupPlan_RetentionPolicy) SetBackupRetainDays(v int32)
func (*BackupPlan_RetentionPolicy) SetLocked ¶
func (x *BackupPlan_RetentionPolicy) SetLocked(v bool)
func (*BackupPlan_RetentionPolicy) String ¶
func (x *BackupPlan_RetentionPolicy) String() string
type BackupPlan_RetentionPolicy_builder ¶
type BackupPlan_RetentionPolicy_builder 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
// 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
// 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
// contains filtered or unexported fields
}
func (BackupPlan_RetentionPolicy_builder) Build ¶
func (b0 BackupPlan_RetentionPolicy_builder) Build() *BackupPlan_RetentionPolicy
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) 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) SetCronSchedule ¶
func (x *BackupPlan_Schedule) SetCronSchedule(v string)
func (*BackupPlan_Schedule) SetPaused ¶
func (x *BackupPlan_Schedule) SetPaused(v bool)
func (*BackupPlan_Schedule) String ¶
func (x *BackupPlan_Schedule) String() string
type BackupPlan_Schedule_builder ¶
type BackupPlan_Schedule_builder 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
// This flag denotes whether automatic Backup creation is paused for this
// BackupPlan.
//
// Default: False
Paused bool
// contains filtered or unexported fields
}
func (BackupPlan_Schedule_builder) Build ¶
func (b0 BackupPlan_Schedule_builder) Build() *BackupPlan_Schedule
type BackupPlan_builder ¶
type BackupPlan_builder struct {
// Output only. The full name of the BackupPlan resource.
// Format: `projects/*/locations/*/backupPlans/*`
Name string
// Output only. Server generated global unique identifier of
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
Uid string
// Output only. The timestamp when this BackupPlan resource was created.
CreateTime *timestamppb.Timestamp
// Output only. The timestamp when this BackupPlan resource was last
// updated.
UpdateTime *timestamppb.Timestamp
// User specified descriptive string for this BackupPlan.
Description string
// Required. Immutable. The source cluster from which Backups will be created
// via this BackupPlan. Valid formats:
//
// - `projects/*/locations/*/clusters/*`
// - `projects/*/zones/*/clusters/*`
Cluster string
// RetentionPolicy governs lifecycle of Backups created under this plan.
RetentionPolicy *BackupPlan_RetentionPolicy
// A set of custom labels supplied by user.
Labels map[string]string
// Defines a schedule for automatic Backup creation via this BackupPlan.
BackupSchedule *BackupPlan_Schedule
// 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
// 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
// Defines the configuration of Backups created via this BackupPlan.
BackupConfig *BackupPlan_BackupConfig
// Output only. The number of Kubernetes Pods backed up in the
// last successful Backup created via this BackupPlan.
ProtectedPodCount int32
// contains filtered or unexported fields
}
func (BackupPlan_builder) Build ¶
func (b0 BackupPlan_builder) Build() *BackupPlan
type BackupUpdatedEvent ¶
type BackupUpdatedEvent struct {
// The data associated with the event.
Data *BackupEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a Backup is updated.
func (*BackupUpdatedEvent) ClearData ¶
func (x *BackupUpdatedEvent) ClearData()
func (*BackupUpdatedEvent) GetData ¶
func (x *BackupUpdatedEvent) GetData() *BackupEventData
func (*BackupUpdatedEvent) HasData ¶
func (x *BackupUpdatedEvent) HasData() bool
func (*BackupUpdatedEvent) ProtoMessage ¶
func (*BackupUpdatedEvent) ProtoMessage()
func (*BackupUpdatedEvent) ProtoReflect ¶
func (x *BackupUpdatedEvent) ProtoReflect() protoreflect.Message
func (*BackupUpdatedEvent) Reset ¶
func (x *BackupUpdatedEvent) Reset()
func (*BackupUpdatedEvent) SetData ¶
func (x *BackupUpdatedEvent) SetData(v *BackupEventData)
func (*BackupUpdatedEvent) String ¶
func (x *BackupUpdatedEvent) String() string
type BackupUpdatedEvent_builder ¶
type BackupUpdatedEvent_builder struct {
// The data associated with the event.
Data *BackupEventData
// contains filtered or unexported fields
}
func (BackupUpdatedEvent_builder) Build ¶
func (b0 BackupUpdatedEvent_builder) Build() *BackupUpdatedEvent
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 `` /* 188-byte string literal not displayed */
// Platform-specific version
//
// Types that are valid to be assigned 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) ClearAnthosVersion ¶
func (x *Backup_ClusterMetadata) ClearAnthosVersion()
func (*Backup_ClusterMetadata) ClearGkeVersion ¶
func (x *Backup_ClusterMetadata) ClearGkeVersion()
func (*Backup_ClusterMetadata) ClearPlatformVersion ¶
func (x *Backup_ClusterMetadata) ClearPlatformVersion()
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 (x *Backup_ClusterMetadata) GetPlatformVersion() isBackup_ClusterMetadata_PlatformVersion
func (*Backup_ClusterMetadata) HasAnthosVersion ¶
func (x *Backup_ClusterMetadata) HasAnthosVersion() bool
func (*Backup_ClusterMetadata) HasGkeVersion ¶
func (x *Backup_ClusterMetadata) HasGkeVersion() bool
func (*Backup_ClusterMetadata) HasPlatformVersion ¶
func (x *Backup_ClusterMetadata) HasPlatformVersion() bool
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) SetAnthosVersion ¶
func (x *Backup_ClusterMetadata) SetAnthosVersion(v string)
func (*Backup_ClusterMetadata) SetBackupCrdVersions ¶
func (x *Backup_ClusterMetadata) SetBackupCrdVersions(v map[string]string)
func (*Backup_ClusterMetadata) SetCluster ¶
func (x *Backup_ClusterMetadata) SetCluster(v string)
func (*Backup_ClusterMetadata) SetGkeVersion ¶
func (x *Backup_ClusterMetadata) SetGkeVersion(v string)
func (*Backup_ClusterMetadata) SetK8SVersion ¶
func (x *Backup_ClusterMetadata) SetK8SVersion(v string)
func (*Backup_ClusterMetadata) String ¶
func (x *Backup_ClusterMetadata) String() string
func (*Backup_ClusterMetadata) WhichPlatformVersion ¶
func (x *Backup_ClusterMetadata) WhichPlatformVersion() case_Backup_ClusterMetadata_PlatformVersion
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_ClusterMetadata_builder ¶
type Backup_ClusterMetadata_builder 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
// The Kubernetes server version of the source cluster.
K8SVersion string
// A list of the Backup for GKE CRD versions found in the cluster.
BackupCrdVersions map[string]string
// Fields of oneof PlatformVersion:
// GKE version
GkeVersion *string
// Anthos version
AnthosVersion *string
// contains filtered or unexported fields
}
func (Backup_ClusterMetadata_builder) Build ¶
func (b0 Backup_ClusterMetadata_builder) Build() *Backup_ClusterMetadata
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) 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 Backup_builder ¶
type Backup_builder struct {
// Output only. The fully qualified name of the Backup.
// `projects/*/locations/*/backupPlans/*/backups/*`
Name string
// Output only. Server generated global unique identifier of
// [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
Uid string
// Output only. The timestamp when this Backup resource was created.
CreateTime *timestamppb.Timestamp
// Output only. The timestamp when this Backup resource was last updated.
UpdateTime *timestamppb.Timestamp
// 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
// A set of custom labels supplied by user.
Labels map[string]string
// 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
// 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
// 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
// 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
// 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
// Fields of oneof BackupScope:
// Output only. If True, all namespaces were included in the Backup.
AllNamespaces *bool
// Output only. If set, the list of namespaces that were included in the
// Backup.
SelectedNamespaces *Namespaces
// Output only. If set, the list of ProtectedApplications whose resources
// were included in the Backup.
SelectedApplications *NamespacedNames
// -- end of BackupScope
// 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
// 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
// Output only. Information about the GKE cluster from which this Backup was
// created.
ClusterMetadata *Backup_ClusterMetadata
// Output only. Current state of the Backup
State Backup_State
// Output only. Human-readable description of why the backup is in the current
// `state`.
StateReason string
// Output only. Completion time of the Backup
CompleteTime *timestamppb.Timestamp
// Output only. The total number of Kubernetes resources included in the
// Backup.
ResourceCount int32
// Output only. The total number of volume backups contained in the Backup.
VolumeCount int32
// Output only. The total size of the Backup in bytes = config backup size +
// sum(volume backup sizes)
SizeBytes int64
// 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
// User specified descriptive string for this Backup.
Description string
// Output only. The total number of Kubernetes Pods contained in the Backup.
PodCount int32
// Output only. The size of the config backup in bytes.
ConfigBackupSizeBytes int64
// contains filtered or unexported fields
}
func (Backup_builder) Build ¶
func (b0 Backup_builder) Build() *Backup
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) 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) SetGcpKmsEncryptionKey ¶
func (x *EncryptionKey) SetGcpKmsEncryptionKey(v string)
func (*EncryptionKey) String ¶
func (x *EncryptionKey) String() string
type EncryptionKey_builder ¶
type EncryptionKey_builder struct {
// Google Cloud KMS encryption key. Format:
// `projects/*/locations/*/keyRings/*/cryptoKeys/*`
GcpKmsEncryptionKey string
// contains filtered or unexported fields
}
func (EncryptionKey_builder) Build ¶
func (b0 EncryptionKey_builder) Build() *EncryptionKey
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) 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) SetName ¶
func (x *NamespacedName) SetName(v string)
func (*NamespacedName) SetNamespace ¶
func (x *NamespacedName) SetNamespace(v string)
func (*NamespacedName) String ¶
func (x *NamespacedName) String() string
type NamespacedName_builder ¶
type NamespacedName_builder struct {
// The Namespace of the Kubernetes resource.
Namespace string
// The name of the Kubernetes resource.
Name string
// contains filtered or unexported fields
}
func (NamespacedName_builder) Build ¶
func (b0 NamespacedName_builder) Build() *NamespacedName
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) 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) SetNamespacedNames ¶
func (x *NamespacedNames) SetNamespacedNames(v []*NamespacedName)
func (*NamespacedNames) String ¶
func (x *NamespacedNames) String() string
type NamespacedNames_builder ¶
type NamespacedNames_builder struct {
// A list of namespaced Kubernetes resources.
NamespacedNames []*NamespacedName
// contains filtered or unexported fields
}
func (NamespacedNames_builder) Build ¶
func (b0 NamespacedNames_builder) Build() *NamespacedNames
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) 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) SetNamespaces ¶
func (x *Namespaces) SetNamespaces(v []string)
func (*Namespaces) String ¶
func (x *Namespaces) String() string
type Namespaces_builder ¶
type Namespaces_builder struct {
// A list of Kubernetes Namespaces
Namespaces []string
// contains filtered or unexported fields
}
func (Namespaces_builder) Build ¶
func (b0 Namespaces_builder) Build() *Namespaces
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 `` /* 139-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) GetCompleteTime ¶
func (x *Restore) GetCompleteTime() *timestamppb.Timestamp
func (*Restore) GetCreateTime ¶
func (x *Restore) GetCreateTime() *timestamppb.Timestamp
func (*Restore) GetRestoreConfig ¶
func (x *Restore) GetRestoreConfig() *RestoreConfig
func (*Restore) GetState ¶
func (x *Restore) GetState() Restore_State
func (*Restore) GetUpdateTime ¶
func (x *Restore) GetUpdateTime() *timestamppb.Timestamp
func (*Restore) ProtoReflect ¶
func (x *Restore) ProtoReflect() protoreflect.Message
func (*Restore) SetCompleteTime ¶
func (x *Restore) SetCompleteTime(v *timestamppb.Timestamp)
func (*Restore) SetCreateTime ¶
func (x *Restore) SetCreateTime(v *timestamppb.Timestamp)
func (*Restore) SetRestoreConfig ¶
func (x *Restore) SetRestoreConfig(v *RestoreConfig)
func (*Restore) SetState ¶
func (x *Restore) SetState(v Restore_State)
func (*Restore) SetUpdateTime ¶
func (x *Restore) SetUpdateTime(v *timestamppb.Timestamp)
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 valid to be assigned 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) ClearAllNamespaces ¶
func (x *RestoreConfig) ClearAllNamespaces()
func (*RestoreConfig) ClearClusterResourceRestoreScope ¶
func (x *RestoreConfig) ClearClusterResourceRestoreScope()
func (*RestoreConfig) ClearNamespacedResourceRestoreScope ¶
func (x *RestoreConfig) ClearNamespacedResourceRestoreScope()
func (*RestoreConfig) ClearSelectedApplications ¶
func (x *RestoreConfig) ClearSelectedApplications()
func (*RestoreConfig) ClearSelectedNamespaces ¶
func (x *RestoreConfig) ClearSelectedNamespaces()
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 (x *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) HasAllNamespaces ¶
func (x *RestoreConfig) HasAllNamespaces() bool
func (*RestoreConfig) HasClusterResourceRestoreScope ¶
func (x *RestoreConfig) HasClusterResourceRestoreScope() bool
func (*RestoreConfig) HasNamespacedResourceRestoreScope ¶
func (x *RestoreConfig) HasNamespacedResourceRestoreScope() bool
func (*RestoreConfig) HasSelectedApplications ¶
func (x *RestoreConfig) HasSelectedApplications() bool
func (*RestoreConfig) HasSelectedNamespaces ¶
func (x *RestoreConfig) HasSelectedNamespaces() bool
func (*RestoreConfig) ProtoMessage ¶
func (*RestoreConfig) ProtoMessage()
func (*RestoreConfig) ProtoReflect ¶
func (x *RestoreConfig) ProtoReflect() protoreflect.Message
func (*RestoreConfig) Reset ¶
func (x *RestoreConfig) Reset()
func (*RestoreConfig) SetAllNamespaces ¶
func (x *RestoreConfig) SetAllNamespaces(v bool)
func (*RestoreConfig) SetClusterResourceConflictPolicy ¶
func (x *RestoreConfig) SetClusterResourceConflictPolicy(v RestoreConfig_ClusterResourceConflictPolicy)
func (*RestoreConfig) SetClusterResourceRestoreScope ¶
func (x *RestoreConfig) SetClusterResourceRestoreScope(v *RestoreConfig_ClusterResourceRestoreScope)
func (*RestoreConfig) SetNamespacedResourceRestoreMode ¶
func (x *RestoreConfig) SetNamespacedResourceRestoreMode(v RestoreConfig_NamespacedResourceRestoreMode)
func (*RestoreConfig) SetSelectedApplications ¶
func (x *RestoreConfig) SetSelectedApplications(v *NamespacedNames)
func (*RestoreConfig) SetSelectedNamespaces ¶
func (x *RestoreConfig) SetSelectedNamespaces(v *Namespaces)
func (*RestoreConfig) SetSubstitutionRules ¶
func (x *RestoreConfig) SetSubstitutionRules(v []*RestoreConfig_SubstitutionRule)
func (*RestoreConfig) SetVolumeDataRestorePolicy ¶
func (x *RestoreConfig) SetVolumeDataRestorePolicy(v RestoreConfig_VolumeDataRestorePolicy)
func (*RestoreConfig) String ¶
func (x *RestoreConfig) String() string
func (*RestoreConfig) WhichNamespacedResourceRestoreScope ¶
func (x *RestoreConfig) WhichNamespacedResourceRestoreScope() case_RestoreConfig_NamespacedResourceRestoreScope
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) Enum ¶
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) 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) SetSelectedGroupKinds ¶
func (x *RestoreConfig_ClusterResourceRestoreScope) SetSelectedGroupKinds(v []*RestoreConfig_GroupKind)
func (*RestoreConfig_ClusterResourceRestoreScope) String ¶
func (x *RestoreConfig_ClusterResourceRestoreScope) String() string
type RestoreConfig_ClusterResourceRestoreScope_builder ¶
type RestoreConfig_ClusterResourceRestoreScope_builder 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
// contains filtered or unexported fields
}
func (RestoreConfig_ClusterResourceRestoreScope_builder) Build ¶
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) 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) SetResourceGroup ¶
func (x *RestoreConfig_GroupKind) SetResourceGroup(v string)
func (*RestoreConfig_GroupKind) SetResourceKind ¶
func (x *RestoreConfig_GroupKind) SetResourceKind(v string)
func (*RestoreConfig_GroupKind) String ¶
func (x *RestoreConfig_GroupKind) String() string
type RestoreConfig_GroupKind_builder ¶
type RestoreConfig_GroupKind_builder 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
// Kind of a Kubernetes resource, e.g.
// "CustomResourceDefinition", "StorageClass", etc.
ResourceKind string
// contains filtered or unexported fields
}
func (RestoreConfig_GroupKind_builder) Build ¶
func (b0 RestoreConfig_GroupKind_builder) Build() *RestoreConfig_GroupKind
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) Enum ¶
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) 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) SetNewValue ¶
func (x *RestoreConfig_SubstitutionRule) SetNewValue(v string)
func (*RestoreConfig_SubstitutionRule) SetOriginalValuePattern ¶
func (x *RestoreConfig_SubstitutionRule) SetOriginalValuePattern(v string)
func (*RestoreConfig_SubstitutionRule) SetTargetGroupKinds ¶
func (x *RestoreConfig_SubstitutionRule) SetTargetGroupKinds(v []*RestoreConfig_GroupKind)
func (*RestoreConfig_SubstitutionRule) SetTargetJsonPath ¶
func (x *RestoreConfig_SubstitutionRule) SetTargetJsonPath(v string)
func (*RestoreConfig_SubstitutionRule) SetTargetNamespaces ¶
func (x *RestoreConfig_SubstitutionRule) SetTargetNamespaces(v []string)
func (*RestoreConfig_SubstitutionRule) String ¶
func (x *RestoreConfig_SubstitutionRule) String() string
type RestoreConfig_SubstitutionRule_builder ¶
type RestoreConfig_SubstitutionRule_builder 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
// (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
// 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
// (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
// 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
// contains filtered or unexported fields
}
func (RestoreConfig_SubstitutionRule_builder) Build ¶
func (b0 RestoreConfig_SubstitutionRule_builder) Build() *RestoreConfig_SubstitutionRule
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) Enum ¶
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 RestoreConfig_builder ¶
type RestoreConfig_builder 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
// 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
// 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
// Identifies the cluster-scoped resources to restore from the Backup.
// Not specifying it means NO cluster resource will be restored.
ClusterResourceRestoreScope *RestoreConfig_ClusterResourceRestoreScope
// Fields of oneof NamespacedResourceRestoreScope:
// Restore all namespaced resources in the Backup if set to "True".
// Specifying this field to "False" is an error.
AllNamespaces *bool
// A list of selected Namespaces to restore from the Backup. The listed
// Namespaces and all resources contained in them will be restored.
SelectedNamespaces *Namespaces
// A list of selected ProtectedApplications to restore. The listed
// ProtectedApplications and all the resources to which they refer will be
// restored.
SelectedApplications *NamespacedNames
// -- end of NamespacedResourceRestoreScope
// 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
// contains filtered or unexported fields
}
func (RestoreConfig_builder) Build ¶
func (b0 RestoreConfig_builder) Build() *RestoreConfig
type RestoreCreatedEvent ¶
type RestoreCreatedEvent struct {
// The data associated with the event.
Data *RestoreEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a Restore is created.
func (*RestoreCreatedEvent) ClearData ¶
func (x *RestoreCreatedEvent) ClearData()
func (*RestoreCreatedEvent) GetData ¶
func (x *RestoreCreatedEvent) GetData() *RestoreEventData
func (*RestoreCreatedEvent) HasData ¶
func (x *RestoreCreatedEvent) HasData() bool
func (*RestoreCreatedEvent) ProtoMessage ¶
func (*RestoreCreatedEvent) ProtoMessage()
func (*RestoreCreatedEvent) ProtoReflect ¶
func (x *RestoreCreatedEvent) ProtoReflect() protoreflect.Message
func (*RestoreCreatedEvent) Reset ¶
func (x *RestoreCreatedEvent) Reset()
func (*RestoreCreatedEvent) SetData ¶
func (x *RestoreCreatedEvent) SetData(v *RestoreEventData)
func (*RestoreCreatedEvent) String ¶
func (x *RestoreCreatedEvent) String() string
type RestoreCreatedEvent_builder ¶
type RestoreCreatedEvent_builder struct {
// The data associated with the event.
Data *RestoreEventData
// contains filtered or unexported fields
}
func (RestoreCreatedEvent_builder) Build ¶
func (b0 RestoreCreatedEvent_builder) Build() *RestoreCreatedEvent
type RestoreDeletedEvent ¶
type RestoreDeletedEvent struct {
// The data associated with the event.
Data *RestoreEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a Restore is deleted.
func (*RestoreDeletedEvent) ClearData ¶
func (x *RestoreDeletedEvent) ClearData()
func (*RestoreDeletedEvent) GetData ¶
func (x *RestoreDeletedEvent) GetData() *RestoreEventData
func (*RestoreDeletedEvent) HasData ¶
func (x *RestoreDeletedEvent) HasData() bool
func (*RestoreDeletedEvent) ProtoMessage ¶
func (*RestoreDeletedEvent) ProtoMessage()
func (*RestoreDeletedEvent) ProtoReflect ¶
func (x *RestoreDeletedEvent) ProtoReflect() protoreflect.Message
func (*RestoreDeletedEvent) Reset ¶
func (x *RestoreDeletedEvent) Reset()
func (*RestoreDeletedEvent) SetData ¶
func (x *RestoreDeletedEvent) SetData(v *RestoreEventData)
func (*RestoreDeletedEvent) String ¶
func (x *RestoreDeletedEvent) String() string
type RestoreDeletedEvent_builder ¶
type RestoreDeletedEvent_builder struct {
// The data associated with the event.
Data *RestoreEventData
// contains filtered or unexported fields
}
func (RestoreDeletedEvent_builder) Build ¶
func (b0 RestoreDeletedEvent_builder) Build() *RestoreDeletedEvent
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) ClearPayload ¶
func (x *RestoreEventData) ClearPayload()
func (*RestoreEventData) GetPayload ¶
func (x *RestoreEventData) GetPayload() *Restore
func (*RestoreEventData) HasPayload ¶
func (x *RestoreEventData) HasPayload() bool
func (*RestoreEventData) ProtoMessage ¶
func (*RestoreEventData) ProtoMessage()
func (*RestoreEventData) ProtoReflect ¶
func (x *RestoreEventData) ProtoReflect() protoreflect.Message
func (*RestoreEventData) Reset ¶
func (x *RestoreEventData) Reset()
func (*RestoreEventData) SetPayload ¶
func (x *RestoreEventData) SetPayload(v *Restore)
func (*RestoreEventData) String ¶
func (x *RestoreEventData) String() string
type RestoreEventData_builder ¶
type RestoreEventData_builder struct {
// Optional. The Restore event payload. Unset for deletion events.
Payload *Restore
// contains filtered or unexported fields
}
func (RestoreEventData_builder) Build ¶
func (b0 RestoreEventData_builder) Build() *RestoreEventData
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 `` /* 139-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) ClearCreateTime ¶
func (x *RestorePlan) ClearCreateTime()
func (*RestorePlan) ClearRestoreConfig ¶
func (x *RestorePlan) ClearRestoreConfig()
func (*RestorePlan) ClearUpdateTime ¶
func (x *RestorePlan) ClearUpdateTime()
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) HasCreateTime ¶
func (x *RestorePlan) HasCreateTime() bool
func (*RestorePlan) HasRestoreConfig ¶
func (x *RestorePlan) HasRestoreConfig() bool
func (*RestorePlan) HasUpdateTime ¶
func (x *RestorePlan) HasUpdateTime() bool
func (*RestorePlan) ProtoMessage ¶
func (*RestorePlan) ProtoMessage()
func (*RestorePlan) ProtoReflect ¶
func (x *RestorePlan) ProtoReflect() protoreflect.Message
func (*RestorePlan) Reset ¶
func (x *RestorePlan) Reset()
func (*RestorePlan) SetBackupPlan ¶
func (x *RestorePlan) SetBackupPlan(v string)
func (*RestorePlan) SetCluster ¶
func (x *RestorePlan) SetCluster(v string)
func (*RestorePlan) SetCreateTime ¶
func (x *RestorePlan) SetCreateTime(v *timestamppb.Timestamp)
func (*RestorePlan) SetDescription ¶
func (x *RestorePlan) SetDescription(v string)
func (*RestorePlan) SetEtag ¶
func (x *RestorePlan) SetEtag(v string)
func (*RestorePlan) SetLabels ¶
func (x *RestorePlan) SetLabels(v map[string]string)
func (*RestorePlan) SetName ¶
func (x *RestorePlan) SetName(v string)
func (*RestorePlan) SetRestoreConfig ¶
func (x *RestorePlan) SetRestoreConfig(v *RestoreConfig)
func (*RestorePlan) SetUid ¶
func (x *RestorePlan) SetUid(v string)
func (*RestorePlan) SetUpdateTime ¶
func (x *RestorePlan) SetUpdateTime(v *timestamppb.Timestamp)
func (*RestorePlan) String ¶
func (x *RestorePlan) String() string
type RestorePlanCreatedEvent ¶
type RestorePlanCreatedEvent struct {
// The data associated with the event.
Data *RestorePlanEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a RestorePlan is created.
func (*RestorePlanCreatedEvent) ClearData ¶
func (x *RestorePlanCreatedEvent) ClearData()
func (*RestorePlanCreatedEvent) GetData ¶
func (x *RestorePlanCreatedEvent) GetData() *RestorePlanEventData
func (*RestorePlanCreatedEvent) HasData ¶
func (x *RestorePlanCreatedEvent) HasData() bool
func (*RestorePlanCreatedEvent) ProtoMessage ¶
func (*RestorePlanCreatedEvent) ProtoMessage()
func (*RestorePlanCreatedEvent) ProtoReflect ¶
func (x *RestorePlanCreatedEvent) ProtoReflect() protoreflect.Message
func (*RestorePlanCreatedEvent) Reset ¶
func (x *RestorePlanCreatedEvent) Reset()
func (*RestorePlanCreatedEvent) SetData ¶
func (x *RestorePlanCreatedEvent) SetData(v *RestorePlanEventData)
func (*RestorePlanCreatedEvent) String ¶
func (x *RestorePlanCreatedEvent) String() string
type RestorePlanCreatedEvent_builder ¶
type RestorePlanCreatedEvent_builder struct {
// The data associated with the event.
Data *RestorePlanEventData
// contains filtered or unexported fields
}
func (RestorePlanCreatedEvent_builder) Build ¶
func (b0 RestorePlanCreatedEvent_builder) Build() *RestorePlanCreatedEvent
type RestorePlanDeletedEvent ¶
type RestorePlanDeletedEvent struct {
// The data associated with the event.
Data *RestorePlanEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a RestorePlan is deleted.
func (*RestorePlanDeletedEvent) ClearData ¶
func (x *RestorePlanDeletedEvent) ClearData()
func (*RestorePlanDeletedEvent) GetData ¶
func (x *RestorePlanDeletedEvent) GetData() *RestorePlanEventData
func (*RestorePlanDeletedEvent) HasData ¶
func (x *RestorePlanDeletedEvent) HasData() bool
func (*RestorePlanDeletedEvent) ProtoMessage ¶
func (*RestorePlanDeletedEvent) ProtoMessage()
func (*RestorePlanDeletedEvent) ProtoReflect ¶
func (x *RestorePlanDeletedEvent) ProtoReflect() protoreflect.Message
func (*RestorePlanDeletedEvent) Reset ¶
func (x *RestorePlanDeletedEvent) Reset()
func (*RestorePlanDeletedEvent) SetData ¶
func (x *RestorePlanDeletedEvent) SetData(v *RestorePlanEventData)
func (*RestorePlanDeletedEvent) String ¶
func (x *RestorePlanDeletedEvent) String() string
type RestorePlanDeletedEvent_builder ¶
type RestorePlanDeletedEvent_builder struct {
// The data associated with the event.
Data *RestorePlanEventData
// contains filtered or unexported fields
}
func (RestorePlanDeletedEvent_builder) Build ¶
func (b0 RestorePlanDeletedEvent_builder) Build() *RestorePlanDeletedEvent
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) ClearPayload ¶
func (x *RestorePlanEventData) ClearPayload()
func (*RestorePlanEventData) GetPayload ¶
func (x *RestorePlanEventData) GetPayload() *RestorePlan
func (*RestorePlanEventData) HasPayload ¶
func (x *RestorePlanEventData) HasPayload() bool
func (*RestorePlanEventData) ProtoMessage ¶
func (*RestorePlanEventData) ProtoMessage()
func (*RestorePlanEventData) ProtoReflect ¶
func (x *RestorePlanEventData) ProtoReflect() protoreflect.Message
func (*RestorePlanEventData) Reset ¶
func (x *RestorePlanEventData) Reset()
func (*RestorePlanEventData) SetPayload ¶
func (x *RestorePlanEventData) SetPayload(v *RestorePlan)
func (*RestorePlanEventData) String ¶
func (x *RestorePlanEventData) String() string
type RestorePlanEventData_builder ¶
type RestorePlanEventData_builder struct {
// Optional. The RestorePlan event payload. Unset for deletion events.
Payload *RestorePlan
// contains filtered or unexported fields
}
func (RestorePlanEventData_builder) Build ¶
func (b0 RestorePlanEventData_builder) Build() *RestorePlanEventData
type RestorePlanUpdatedEvent ¶
type RestorePlanUpdatedEvent struct {
// The data associated with the event.
Data *RestorePlanEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a RestorePlan is updated.
func (*RestorePlanUpdatedEvent) ClearData ¶
func (x *RestorePlanUpdatedEvent) ClearData()
func (*RestorePlanUpdatedEvent) GetData ¶
func (x *RestorePlanUpdatedEvent) GetData() *RestorePlanEventData
func (*RestorePlanUpdatedEvent) HasData ¶
func (x *RestorePlanUpdatedEvent) HasData() bool
func (*RestorePlanUpdatedEvent) ProtoMessage ¶
func (*RestorePlanUpdatedEvent) ProtoMessage()
func (*RestorePlanUpdatedEvent) ProtoReflect ¶
func (x *RestorePlanUpdatedEvent) ProtoReflect() protoreflect.Message
func (*RestorePlanUpdatedEvent) Reset ¶
func (x *RestorePlanUpdatedEvent) Reset()
func (*RestorePlanUpdatedEvent) SetData ¶
func (x *RestorePlanUpdatedEvent) SetData(v *RestorePlanEventData)
func (*RestorePlanUpdatedEvent) String ¶
func (x *RestorePlanUpdatedEvent) String() string
type RestorePlanUpdatedEvent_builder ¶
type RestorePlanUpdatedEvent_builder struct {
// The data associated with the event.
Data *RestorePlanEventData
// contains filtered or unexported fields
}
func (RestorePlanUpdatedEvent_builder) Build ¶
func (b0 RestorePlanUpdatedEvent_builder) Build() *RestorePlanUpdatedEvent
type RestorePlan_builder ¶
type RestorePlan_builder struct {
// Output only. The full name of the RestorePlan resource.
// Format: `projects/*/locations/*/restorePlans/*`.
Name string
// Output only. Server generated global unique identifier of
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
Uid string
// Output only. The timestamp when this RestorePlan resource was
// created.
CreateTime *timestamppb.Timestamp
// Output only. The timestamp when this RestorePlan resource was last
// updated.
UpdateTime *timestamppb.Timestamp
// User specified descriptive string for this RestorePlan.
Description string
// 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
// 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
// Required. Configuration of Restores created via this RestorePlan.
RestoreConfig *RestoreConfig
// A set of custom labels supplied by user.
Labels map[string]string
// 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
// contains filtered or unexported fields
}
func (RestorePlan_builder) Build ¶
func (b0 RestorePlan_builder) Build() *RestorePlan
type RestoreUpdatedEvent ¶
type RestoreUpdatedEvent struct {
// The data associated with the event.
Data *RestoreEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
The CloudEvent raised when a Restore is updated.
func (*RestoreUpdatedEvent) ClearData ¶
func (x *RestoreUpdatedEvent) ClearData()
func (*RestoreUpdatedEvent) GetData ¶
func (x *RestoreUpdatedEvent) GetData() *RestoreEventData
func (*RestoreUpdatedEvent) HasData ¶
func (x *RestoreUpdatedEvent) HasData() bool
func (*RestoreUpdatedEvent) ProtoMessage ¶
func (*RestoreUpdatedEvent) ProtoMessage()
func (*RestoreUpdatedEvent) ProtoReflect ¶
func (x *RestoreUpdatedEvent) ProtoReflect() protoreflect.Message
func (*RestoreUpdatedEvent) Reset ¶
func (x *RestoreUpdatedEvent) Reset()
func (*RestoreUpdatedEvent) SetData ¶
func (x *RestoreUpdatedEvent) SetData(v *RestoreEventData)
func (*RestoreUpdatedEvent) String ¶
func (x *RestoreUpdatedEvent) String() string
type RestoreUpdatedEvent_builder ¶
type RestoreUpdatedEvent_builder struct {
// The data associated with the event.
Data *RestoreEventData
// contains filtered or unexported fields
}
func (RestoreUpdatedEvent_builder) Build ¶
func (b0 RestoreUpdatedEvent_builder) Build() *RestoreUpdatedEvent
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) 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
type Restore_builder ¶
type Restore_builder struct {
// Output only. The full name of the Restore resource.
// Format: `projects/*/locations/*/restorePlans/*/restores/*`
Name string
// Output only. Server generated global unique identifier of
// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
Uid string
// Output only. The timestamp when this Restore resource was created.
CreateTime *timestamppb.Timestamp
// Output only. The timestamp when this Restore resource was last
// updated.
UpdateTime *timestamppb.Timestamp
// User specified descriptive string for this Restore.
Description string
// 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
// 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
// Output only. Configuration of the Restore. Inherited from parent
// RestorePlan's
// [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].
RestoreConfig *RestoreConfig
// A set of custom labels supplied by user.
Labels map[string]string
// Output only. The current state of the Restore.
State Restore_State
// Output only. Human-readable description of why the Restore is in its
// current state.
StateReason string
// Output only. Timestamp of when the restore operation completed.
CompleteTime *timestamppb.Timestamp
// Output only. Number of resources restored during the restore execution.
ResourcesRestoredCount int32
// Output only. Number of resources excluded during the restore execution.
ResourcesExcludedCount int32
// Output only. Number of resources that failed to be restored during the
// restore execution.
ResourcesFailedCount int32
// Output only. Number of volumes restored during the restore execution.
VolumesRestoredCount int32
// 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
// contains filtered or unexported fields
}
func (Restore_builder) Build ¶
func (b0 Restore_builder) Build() *Restore
Source Files
¶
- data.pb.go
- events.pb.go