logging

package
v0.0.0-...-8af14fe Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	LoggedBackup_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "IN_PROGRESS",
		3: "SUCCEEDED",
		4: "FAILED",
		5: "DELETING",
	}
	LoggedBackup_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"IN_PROGRESS":       2,
		"SUCCEEDED":         3,
		"FAILED":            4,
		"DELETING":          5,
	}
)

Enum value maps for LoggedBackup_State.

View Source 
var (
	LoggedRestore_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "IN_PROGRESS",
		3: "SUCCEEDED",
		4: "FAILED",
		5: "DELETING",
	}
	LoggedRestore_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"IN_PROGRESS":       2,
		"SUCCEEDED":         3,
		"FAILED":            4,
		"DELETING":          5,
	}
)

Enum value maps for LoggedRestore_State.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
var (
	ChangeType_name = map[int32]string{
		0: "CHANGE_TYPE_UNSPECIFIED",
		1: "CREATION",
		2: "UPDATE",
		3: "DELETION",
	}
	ChangeType_value = map[string]int32{
		"CHANGE_TYPE_UNSPECIFIED": 0,
		"CREATION":                1,
		"UPDATE":                  2,
		"DELETION":                3,
	}
)

Enum value maps for ChangeType.

View Source 
var File_google_cloud_gkebackup_logging_v1_logged_backup_plan_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_gkebackup_logging_v1_logged_backup_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_gkebackup_logging_v1_logged_common_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_gkebackup_logging_v1_logged_restore_plan_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_gkebackup_logging_v1_logged_restore_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_gkebackup_logging_v1_logging_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BackupChange 

type BackupChange struct {

	// The full name of the Backup resource that is being modified.
	// Format:
	// projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
	Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
	// Type of the change is being made.
	ChangeType ChangeType `` /* 142-byte string literal not displayed */
	// Whether the change is made manually or automatically.
	Scheduled bool `protobuf:"varint,3,opt,name=scheduled,proto3" json:"scheduled,omitempty"`
	// Modification details.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// The input Backup resource with the updated fields populated to update
	// the source Backup to, or the backup created automatically from retention
	// policy.
	InputBackup *LoggedBackup `protobuf:"bytes,5,opt,name=input_backup,json=inputBackup,proto3" json:"input_backup,omitempty"`
	// The error code and message.
	Error *status.Status `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

use case 2 A log entry when modification(creation, update, deletion) is made to a Backup

func (*BackupChange) Descriptor deprecated 

func (*BackupChange) Descriptor() ([]byte, []int)

Deprecated: Use BackupChange.ProtoReflect.Descriptor instead.

func (*BackupChange) GetBackup 

func (x *BackupChange) GetBackup() string

func (*BackupChange) GetChangeType 

func (x *BackupChange) GetChangeType() ChangeType

func (*BackupChange) GetError 

func (x *BackupChange) GetError() *status.Status

func (*BackupChange) GetInputBackup 

func (x *BackupChange) GetInputBackup() *LoggedBackup

func (*BackupChange) GetScheduled 

func (x *BackupChange) GetScheduled() bool

func (*BackupChange) GetUpdateMask 

func (x *BackupChange) GetUpdateMask() *fieldmaskpb.FieldMask

func (*BackupChange) ProtoMessage 

func (*BackupChange) ProtoMessage()

func (*BackupChange) ProtoReflect 

func (x *BackupChange) ProtoReflect() protoreflect.Message

func (*BackupChange) Reset 

func (x *BackupChange) Reset()

func (*BackupChange) String 

func (x *BackupChange) String() string

type BackupPlanChange 

type BackupPlanChange struct {

	// The full name of the old BackupPlan resource that is being modified.
	// Empty for creation.
	// Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
	BackupPlan string `protobuf:"bytes,1,opt,name=backup_plan,json=backupPlan,proto3" json:"backup_plan,omitempty"`
	// Type of the change is being made.
	ChangeType ChangeType `` /* 142-byte string literal not displayed */
	// Modification details.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// The input BackupPlan resource with the updated fields populated to update
	// the source BackupPlan to.
	InputBackupPlan *LoggedBackupPlan `protobuf:"bytes,4,opt,name=input_backup_plan,json=inputBackupPlan,proto3" json:"input_backup_plan,omitempty"`
	// The error code and message.
	Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

use case 1 A log entry when modification(creation, update, deletion) is made to a BackupPlan

func (*BackupPlanChange) Descriptor deprecated 

func (*BackupPlanChange) Descriptor() ([]byte, []int)

Deprecated: Use BackupPlanChange.ProtoReflect.Descriptor instead.

func (*BackupPlanChange) GetBackupPlan 

func (x *BackupPlanChange) GetBackupPlan() string

func (*BackupPlanChange) GetChangeType 

func (x *BackupPlanChange) GetChangeType() ChangeType

func (*BackupPlanChange) GetError 

func (x *BackupPlanChange) GetError() *status.Status

func (*BackupPlanChange) GetInputBackupPlan 

func (x *BackupPlanChange) GetInputBackupPlan() *LoggedBackupPlan

func (*BackupPlanChange) GetUpdateMask 

func (x *BackupPlanChange) GetUpdateMask() *fieldmaskpb.FieldMask

func (*BackupPlanChange) ProtoMessage 

func (*BackupPlanChange) ProtoMessage()

func (*BackupPlanChange) ProtoReflect 

func (x *BackupPlanChange) ProtoReflect() protoreflect.Message

func (*BackupPlanChange) Reset 

func (x *BackupPlanChange) Reset()

func (*BackupPlanChange) String 

func (x *BackupPlanChange) String() string

type ChangeType 

type ChangeType int32

The type of changes this log is about. 

const (
	// Default value, not specified.
	ChangeType_CHANGE_TYPE_UNSPECIFIED ChangeType = 0
	// The resource is created.
	ChangeType_CREATION ChangeType = 1
	// The resource is updated.
	ChangeType_UPDATE ChangeType = 2
	// The resource is deleted.
	ChangeType_DELETION ChangeType = 3
)

func (ChangeType) Descriptor 

func (ChangeType) Descriptor() protoreflect.EnumDescriptor

func (ChangeType) Enum 

func (x ChangeType) Enum() *ChangeType

func (ChangeType) EnumDescriptor deprecated 

func (ChangeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ChangeType.Descriptor instead.

func (ChangeType) Number 

func (x ChangeType) Number() protoreflect.EnumNumber

func (ChangeType) String 

func (x ChangeType) String() string

func (ChangeType) Type 

func (ChangeType) Type() protoreflect.EnumType

type EncryptionKey 

type EncryptionKey struct {

	// Google KMS encryption key in the format:
	// projects/<project>/locations/<location>/keyRings/<key-ring>/cryptoKeys/<key>
	GcpKmsEncryptionKey string `protobuf:"bytes,1,opt,name=gcp_kms_encryption_key,json=gcpKmsEncryptionKey,proto3" json:"gcp_kms_encryption_key,omitempty"`
	// contains filtered or unexported fields
}

Encryption key. This only contains the key metadata, and no key material.

func (*EncryptionKey) Descriptor deprecated 

func (*EncryptionKey) Descriptor() ([]byte, []int)

Deprecated: Use EncryptionKey.ProtoReflect.Descriptor instead.

func (*EncryptionKey) GetGcpKmsEncryptionKey 

func (x *EncryptionKey) GetGcpKmsEncryptionKey() string

func (*EncryptionKey) ProtoMessage 

func (*EncryptionKey) ProtoMessage()

func (*EncryptionKey) ProtoReflect 

func (x *EncryptionKey) ProtoReflect() protoreflect.Message

func (*EncryptionKey) Reset 

func (x *EncryptionKey) Reset()

func (*EncryptionKey) String 

func (x *EncryptionKey) String() string

type LoggedBackup 

type LoggedBackup struct {

	// A set of custom labels supplied by user.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// delete_lock_days specifies the number of days from the create_time of this
	// Backup before which deletion will be blocked.
	DeleteLockDays int32 `protobuf:"varint,2,opt,name=delete_lock_days,json=deleteLockDays,proto3" json:"delete_lock_days,omitempty"`
	// retain_days specifies the desired number of days from the create_time of
	// this Backup after which it will be automatically deleted.
	RetainDays int32 `protobuf:"varint,3,opt,name=retain_days,json=retainDays,proto3" json:"retain_days,omitempty"`
	// User specified descriptive string for this Backup.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Current state of the Backup
	State LoggedBackup_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.gkebackup.logging.v1.LoggedBackup_State" json:"state,omitempty"`
	// Human-readable description of why the backup is in the current `state`.
	StateReason string `protobuf:"bytes,6,opt,name=state_reason,json=stateReason,proto3" json:"state_reason,omitempty"`
	// contains filtered or unexported fields
}

Backup as stored in Platform log. It's used to log the details of a createBackup/updateBackup request, so only fields that can be taken from API calls are included here.

func (*LoggedBackup) Descriptor deprecated 

func (*LoggedBackup) Descriptor() ([]byte, []int)

Deprecated: Use LoggedBackup.ProtoReflect.Descriptor instead.

func (*LoggedBackup) GetDeleteLockDays 

func (x *LoggedBackup) GetDeleteLockDays() int32

func (*LoggedBackup) GetDescription 

func (x *LoggedBackup) GetDescription() string

func (*LoggedBackup) GetLabels 

func (x *LoggedBackup) GetLabels() map[string]string

func (*LoggedBackup) GetRetainDays 

func (x *LoggedBackup) GetRetainDays() int32

func (*LoggedBackup) GetState 

func (x *LoggedBackup) GetState() LoggedBackup_State

func (*LoggedBackup) GetStateReason 

func (x *LoggedBackup) GetStateReason() string

func (*LoggedBackup) ProtoMessage 

func (*LoggedBackup) ProtoMessage()

func (*LoggedBackup) ProtoReflect 

func (x *LoggedBackup) ProtoReflect() protoreflect.Message

func (*LoggedBackup) Reset 

func (x *LoggedBackup) Reset()

func (*LoggedBackup) String 

func (x *LoggedBackup) String() string

type LoggedBackupPlan 

type LoggedBackupPlan struct {

	// User specified descriptive string for this BackupPlan.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// GCP resource name of the source cluster for this BackupPlan.
	Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// RetentionPolicy governs lifecycle of Backups created under this plan.
	RetentionPolicy *LoggedBackupPlan_RetentionPolicy `protobuf:"bytes,3,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"`
	// A set of custom labels supplied by user.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Defines scheduled Backup creation under this BackupPlan.
	BackupSchedule *LoggedBackupPlan_Schedule `protobuf:"bytes,5,opt,name=backup_schedule,json=backupSchedule,proto3" json:"backup_schedule,omitempty"`
	// A flag indicates whether the plan has been deactivated.
	Deactivated bool `protobuf:"varint,6,opt,name=deactivated,proto3" json:"deactivated,omitempty"`
	// Defines backup configuration of this BackupPlan.
	BackupConfig *LoggedBackupPlan_BackupConfig `protobuf:"bytes,7,opt,name=backup_config,json=backupConfig,proto3" json:"backup_config,omitempty"`
	// contains filtered or unexported fields
}

BackupPlan as stored in Platform log. It's used to log the details of a createBackupPlan/updateBackupPlan request, so only fields that can be taken from user input are included here.

func (*LoggedBackupPlan) Descriptor deprecated 

func (*LoggedBackupPlan) Descriptor() ([]byte, []int)

Deprecated: Use LoggedBackupPlan.ProtoReflect.Descriptor instead.

func (*LoggedBackupPlan) GetBackupConfig 

func (x *LoggedBackupPlan) GetBackupConfig() *LoggedBackupPlan_BackupConfig

func (*LoggedBackupPlan) GetBackupSchedule 

func (x *LoggedBackupPlan) GetBackupSchedule() *LoggedBackupPlan_Schedule

func (*LoggedBackupPlan) GetCluster 

func (x *LoggedBackupPlan) GetCluster() string

func (*LoggedBackupPlan) GetDeactivated 

func (x *LoggedBackupPlan) GetDeactivated() bool

func (*LoggedBackupPlan) GetDescription 

func (x *LoggedBackupPlan) GetDescription() string

func (*LoggedBackupPlan) GetLabels 

func (x *LoggedBackupPlan) GetLabels() map[string]string

func (*LoggedBackupPlan) GetRetentionPolicy 

func (x *LoggedBackupPlan) GetRetentionPolicy() *LoggedBackupPlan_RetentionPolicy

func (*LoggedBackupPlan) ProtoMessage 

func (*LoggedBackupPlan) ProtoMessage()

func (*LoggedBackupPlan) ProtoReflect 

func (x *LoggedBackupPlan) ProtoReflect() protoreflect.Message

func (*LoggedBackupPlan) Reset 

func (x *LoggedBackupPlan) Reset()

func (*LoggedBackupPlan) String 

func (x *LoggedBackupPlan) String() string

type LoggedBackupPlan_BackupConfig 

type LoggedBackupPlan_BackupConfig struct {

	// Types that are assignable to BackupScope:
	//	*LoggedBackupPlan_BackupConfig_AllNamespaces
	//	*LoggedBackupPlan_BackupConfig_SelectedNamespaces
	//	*LoggedBackupPlan_BackupConfig_SelectedApplications
	BackupScope isLoggedBackupPlan_BackupConfig_BackupScope `protobuf_oneof:"backup_scope"`
	// A boolean flag specifies whether volume data should be backed up
	IncludeVolumeData bool `protobuf:"varint,4,opt,name=include_volume_data,json=includeVolumeData,proto3" json:"include_volume_data,omitempty"`
	// A boolean flag specifies whether secrets should be backed up
	IncludeSecrets bool `protobuf:"varint,5,opt,name=include_secrets,json=includeSecrets,proto3" json:"include_secrets,omitempty"`
	// Custom encryption key. For preview, support GCP KMS only.
	// This only contains the key metadata, and no key material.
	EncryptionKey *EncryptionKey `protobuf:"bytes,6,opt,name=encryption_key,json=encryptionKey,proto3" json:"encryption_key,omitempty"`
	// contains filtered or unexported fields
}

BackupConfig, an inner message type defines the configuration of creating a backup from this BackupPlan

func (*LoggedBackupPlan_BackupConfig) Descriptor deprecated 

func (*LoggedBackupPlan_BackupConfig) Descriptor() ([]byte, []int)

Deprecated: Use LoggedBackupPlan_BackupConfig.ProtoReflect.Descriptor instead.

func (*LoggedBackupPlan_BackupConfig) GetAllNamespaces 

func (x *LoggedBackupPlan_BackupConfig) GetAllNamespaces() bool

func (*LoggedBackupPlan_BackupConfig) GetBackupScope 

func (m *LoggedBackupPlan_BackupConfig) GetBackupScope() isLoggedBackupPlan_BackupConfig_BackupScope

func (*LoggedBackupPlan_BackupConfig) GetEncryptionKey 

func (x *LoggedBackupPlan_BackupConfig) GetEncryptionKey() *EncryptionKey

func (*LoggedBackupPlan_BackupConfig) GetIncludeSecrets 

func (x *LoggedBackupPlan_BackupConfig) GetIncludeSecrets() bool

func (*LoggedBackupPlan_BackupConfig) GetIncludeVolumeData 

func (x *LoggedBackupPlan_BackupConfig) GetIncludeVolumeData() bool

func (*LoggedBackupPlan_BackupConfig) GetSelectedApplications 

func (x *LoggedBackupPlan_BackupConfig) GetSelectedApplications() *NamespacedNames

func (*LoggedBackupPlan_BackupConfig) GetSelectedNamespaces 

func (x *LoggedBackupPlan_BackupConfig) GetSelectedNamespaces() *Namespaces

func (*LoggedBackupPlan_BackupConfig) ProtoMessage 

func (*LoggedBackupPlan_BackupConfig) ProtoMessage()

func (*LoggedBackupPlan_BackupConfig) ProtoReflect 

func (x *LoggedBackupPlan_BackupConfig) ProtoReflect() protoreflect.Message

func (*LoggedBackupPlan_BackupConfig) Reset 

func (x *LoggedBackupPlan_BackupConfig) Reset()

func (*LoggedBackupPlan_BackupConfig) String 

func (x *LoggedBackupPlan_BackupConfig) String() string

type LoggedBackupPlan_BackupConfig_AllNamespaces 

type LoggedBackupPlan_BackupConfig_AllNamespaces struct {
	// If set to true, backup whole cluster
	AllNamespaces bool `protobuf:"varint,1,opt,name=all_namespaces,json=allNamespaces,proto3,oneof"`
}

type LoggedBackupPlan_BackupConfig_SelectedApplications 

type LoggedBackupPlan_BackupConfig_SelectedApplications struct {
	// If set, backup the list of applications
	SelectedApplications *NamespacedNames `protobuf:"bytes,3,opt,name=selected_applications,json=selectedApplications,proto3,oneof"`
}

type LoggedBackupPlan_BackupConfig_SelectedNamespaces 

type LoggedBackupPlan_BackupConfig_SelectedNamespaces struct {
	// If set, backup the list of namespaces
	SelectedNamespaces *Namespaces `protobuf:"bytes,2,opt,name=selected_namespaces,json=selectedNamespaces,proto3,oneof"`
}

type LoggedBackupPlan_RetentionPolicy 

type LoggedBackupPlan_RetentionPolicy struct {

	// Number of days during which deletion of a Backup created under this
	// BackupPlan will be blocked.
	BackupDeleteLockDays int32 `` /* 126-byte string literal not displayed */
	// Number of days after which the service will delete a Backup.
	// If specified, a Backup created under this BackupPlan will be
	// automatically deleted after its age reaches create_time +
	// backup_retain_days.
	BackupRetainDays int32 `protobuf:"varint,2,opt,name=backup_retain_days,json=backupRetainDays,proto3" json:"backup_retain_days,omitempty"`
	// A flag denotes that the retention policy of this BackupPlan is locked.
	// If set to True, no further update is allowed on this policy, including
	// the 'locked' field itself.
	// Default to False.
	Locked bool `protobuf:"varint,3,opt,name=locked,proto3" json:"locked,omitempty"`
	// contains filtered or unexported fields
}

RentionPolicy is an inner message type to define: 1. When to automatically delete Backups created under this BackupPlan 2. A plan level minimum Backup retain days which blocks deletion 3. Lock to disallow any policy updates

func (*LoggedBackupPlan_RetentionPolicy) Descriptor deprecated 

func (*LoggedBackupPlan_RetentionPolicy) Descriptor() ([]byte, []int)

Deprecated: Use LoggedBackupPlan_RetentionPolicy.ProtoReflect.Descriptor instead.

func (*LoggedBackupPlan_RetentionPolicy) GetBackupDeleteLockDays 

func (x *LoggedBackupPlan_RetentionPolicy) GetBackupDeleteLockDays() int32

func (*LoggedBackupPlan_RetentionPolicy) GetBackupRetainDays 

func (x *LoggedBackupPlan_RetentionPolicy) GetBackupRetainDays() int32

func (*LoggedBackupPlan_RetentionPolicy) GetLocked 

func (x *LoggedBackupPlan_RetentionPolicy) GetLocked() bool

func (*LoggedBackupPlan_RetentionPolicy) ProtoMessage 

func (*LoggedBackupPlan_RetentionPolicy) ProtoMessage()

func (*LoggedBackupPlan_RetentionPolicy) ProtoReflect 

func (x *LoggedBackupPlan_RetentionPolicy) ProtoReflect() protoreflect.Message

func (*LoggedBackupPlan_RetentionPolicy) Reset 

func (x *LoggedBackupPlan_RetentionPolicy) Reset()

func (*LoggedBackupPlan_RetentionPolicy) String 

func (x *LoggedBackupPlan_RetentionPolicy) String() string

type LoggedBackupPlan_Schedule 

type LoggedBackupPlan_Schedule struct {

	// A cron style string schedule on which an operation will be executed.
	CronSchedule string `protobuf:"bytes,1,opt,name=cron_schedule,json=cronSchedule,proto3" json:"cron_schedule,omitempty"`
	// A flag to toggle scheduled operation.
	Paused bool `protobuf:"varint,2,opt,name=paused,proto3" json:"paused,omitempty"`
	// contains filtered or unexported fields
}

Schedule, an inner message type defines a cron schedule.

func (*LoggedBackupPlan_Schedule) Descriptor deprecated 

func (*LoggedBackupPlan_Schedule) Descriptor() ([]byte, []int)

Deprecated: Use LoggedBackupPlan_Schedule.ProtoReflect.Descriptor instead.

func (*LoggedBackupPlan_Schedule) GetCronSchedule 

func (x *LoggedBackupPlan_Schedule) GetCronSchedule() string

func (*LoggedBackupPlan_Schedule) GetPaused 

func (x *LoggedBackupPlan_Schedule) GetPaused() bool

func (*LoggedBackupPlan_Schedule) ProtoMessage 

func (*LoggedBackupPlan_Schedule) ProtoMessage()

func (*LoggedBackupPlan_Schedule) ProtoReflect 

func (x *LoggedBackupPlan_Schedule) ProtoReflect() protoreflect.Message

func (*LoggedBackupPlan_Schedule) Reset 

func (x *LoggedBackupPlan_Schedule) Reset()

func (*LoggedBackupPlan_Schedule) String 

func (x *LoggedBackupPlan_Schedule) String() string

type LoggedBackup_State 

type LoggedBackup_State int32

State 

const (
	// The Backup resource is in the process of being created.
	LoggedBackup_STATE_UNSPECIFIED LoggedBackup_State = 0
	// The Backup resource has been created and the associated BackupJob
	// Kubernetes resource has been injected into the source cluster.
	LoggedBackup_CREATING LoggedBackup_State = 1
	// The gkebackup agent in the cluster has begun executing the backup
	// operation.
	LoggedBackup_IN_PROGRESS LoggedBackup_State = 2
	// The backup operation has completed successfully.
	LoggedBackup_SUCCEEDED LoggedBackup_State = 3
	// The backup operation has failed.
	LoggedBackup_FAILED LoggedBackup_State = 4
	// This Backup resource (and its associated artifacts) is in the process
	// of being deleted.
	LoggedBackup_DELETING LoggedBackup_State = 5
)

func (LoggedBackup_State) Descriptor 

func (LoggedBackup_State) Descriptor() protoreflect.EnumDescriptor

func (LoggedBackup_State) Enum 

func (x LoggedBackup_State) Enum() *LoggedBackup_State

func (LoggedBackup_State) EnumDescriptor deprecated 

func (LoggedBackup_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use LoggedBackup_State.Descriptor instead.

func (LoggedBackup_State) Number 

func (x LoggedBackup_State) Number() protoreflect.EnumNumber

func (LoggedBackup_State) String 

func (x LoggedBackup_State) String() string

func (LoggedBackup_State) Type 

func (LoggedBackup_State) Type() protoreflect.EnumType

type LoggedRestore 

type LoggedRestore struct {

	// Full name of the Backup resource this Restore resource used to restore
	// from. Format: projects/*/locations/*/backupPlans/*/backups/*.
	Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
	// GCP Labels.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// User specified descriptive string for this Restore.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The current state of the Restore.
	State LoggedRestore_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.gkebackup.logging.v1.LoggedRestore_State" json:"state,omitempty"`
	// Human-readable description of why the Restore is in its current state.
	StateReason string `protobuf:"bytes,5,opt,name=state_reason,json=stateReason,proto3" json:"state_reason,omitempty"`
	// contains filtered or unexported fields
}

Restore as stored in Platform log. It's used to log the update details of a updateRestore request, so only mutable and non-output_only fields are included here..

func (*LoggedRestore) Descriptor deprecated 

func (*LoggedRestore) Descriptor() ([]byte, []int)

Deprecated: Use LoggedRestore.ProtoReflect.Descriptor instead.

func (*LoggedRestore) GetBackup 

func (x *LoggedRestore) GetBackup() string

func (*LoggedRestore) GetDescription 

func (x *LoggedRestore) GetDescription() string

func (*LoggedRestore) GetLabels 

func (x *LoggedRestore) GetLabels() map[string]string

func (*LoggedRestore) GetState 

func (x *LoggedRestore) GetState() LoggedRestore_State

func (*LoggedRestore) GetStateReason 

func (x *LoggedRestore) GetStateReason() string

func (*LoggedRestore) ProtoMessage 

func (*LoggedRestore) ProtoMessage()

func (*LoggedRestore) ProtoReflect 

func (x *LoggedRestore) ProtoReflect() protoreflect.Message

func (*LoggedRestore) Reset 

func (x *LoggedRestore) Reset()

func (*LoggedRestore) String 

func (x *LoggedRestore) String() string

type LoggedRestorePlan 

type LoggedRestorePlan struct {

	// User specified descriptive string for this RestorePlan.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// The BackupPlan from which Backups may be used as the source
	// for Restores created via this RestorePlan.
	// Format: projects/*/locations/*/backupPlans/*.
	BackupPlan string `protobuf:"bytes,2,opt,name=backup_plan,json=backupPlan,proto3" json:"backup_plan,omitempty"`
	// The target cluster into which Restores created via this RestorePlan
	// will restore data. NOTE: the cluster's region must be the same as the
	// RestorePlan.
	// Possible formats:
	//   1. projects/*/locations/*/clusters/*
	//   2. projects/*/zones/*/clusters/*
	Cluster string `protobuf:"bytes,3,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// Configuration of Restores created via this RestorePlan.
	RestoreConfig *RestoreConfig `protobuf:"bytes,4,opt,name=restore_config,json=restoreConfig,proto3" json:"restore_config,omitempty"`
	// A set of custom labels supplied by user.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

RestorePlan as stored in Platform log. It's used to log the details of a createRestorePlan/updateRestorePlan request, so only fields that can be taken from user input are included here.

func (*LoggedRestorePlan) Descriptor deprecated 

func (*LoggedRestorePlan) Descriptor() ([]byte, []int)

Deprecated: Use LoggedRestorePlan.ProtoReflect.Descriptor instead.

func (*LoggedRestorePlan) GetBackupPlan 

func (x *LoggedRestorePlan) GetBackupPlan() string

func (*LoggedRestorePlan) GetCluster 

func (x *LoggedRestorePlan) GetCluster() string

func (*LoggedRestorePlan) GetDescription 

func (x *LoggedRestorePlan) GetDescription() string

func (*LoggedRestorePlan) GetLabels 

func (x *LoggedRestorePlan) GetLabels() map[string]string

func (*LoggedRestorePlan) GetRestoreConfig 

func (x *LoggedRestorePlan) GetRestoreConfig() *RestoreConfig

func (*LoggedRestorePlan) ProtoMessage 

func (*LoggedRestorePlan) ProtoMessage()

func (*LoggedRestorePlan) ProtoReflect 

func (x *LoggedRestorePlan) ProtoReflect() protoreflect.Message

func (*LoggedRestorePlan) Reset 

func (x *LoggedRestorePlan) Reset()

func (*LoggedRestorePlan) String 

func (x *LoggedRestorePlan) String() string

type LoggedRestore_State 

type LoggedRestore_State int32

Possible values for state of the Restore. 

const (
	// The Restore resource is in the process of being created.
	LoggedRestore_STATE_UNSPECIFIED LoggedRestore_State = 0
	// The Restore resource has been created and the associated RestoreJob
	// Kubernetes resource has been injected into target cluster.
	LoggedRestore_CREATING LoggedRestore_State = 1
	// The gkebackup agent in the cluster has begun executing the restore
	// operation.
	LoggedRestore_IN_PROGRESS LoggedRestore_State = 2
	// The restore operation has completed successfully. Restored workloads may
	// not yet be operational.
	LoggedRestore_SUCCEEDED LoggedRestore_State = 3
	// The restore operation has failed.
	LoggedRestore_FAILED LoggedRestore_State = 4
	// This Restore resource is in the process of being deleted.
	LoggedRestore_DELETING LoggedRestore_State = 5
)

func (LoggedRestore_State) Descriptor 

func (LoggedRestore_State) Descriptor() protoreflect.EnumDescriptor

func (LoggedRestore_State) Enum 

func (x LoggedRestore_State) Enum() *LoggedRestore_State

func (LoggedRestore_State) EnumDescriptor deprecated 

func (LoggedRestore_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use LoggedRestore_State.Descriptor instead.

func (LoggedRestore_State) Number 

func (x LoggedRestore_State) Number() protoreflect.EnumNumber

func (LoggedRestore_State) String 

func (x LoggedRestore_State) String() string

func (LoggedRestore_State) Type 

func (LoggedRestore_State) Type() protoreflect.EnumType

type NamespacedName 

type NamespacedName struct {

	// the namespace of the resource in Kubernetes
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// the name of the resource in Kubernetes
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

NamespacedName

func (*NamespacedName) Descriptor deprecated 

func (*NamespacedName) Descriptor() ([]byte, []int)

Deprecated: Use NamespacedName.ProtoReflect.Descriptor instead.

func (*NamespacedName) GetName 

func (x *NamespacedName) GetName() string

func (*NamespacedName) GetNamespace 

func (x *NamespacedName) GetNamespace() string

func (*NamespacedName) ProtoMessage 

func (*NamespacedName) ProtoMessage()

func (*NamespacedName) ProtoReflect 

func (x *NamespacedName) ProtoReflect() protoreflect.Message

func (*NamespacedName) Reset 

func (x *NamespacedName) Reset()

func (*NamespacedName) String 

func (x *NamespacedName) String() string

type NamespacedNames 

type NamespacedNames struct {

	// a list of namespaced names in Kubernetes
	NamespacedNames []*NamespacedName `protobuf:"bytes,1,rep,name=namespaced_names,json=namespacedNames,proto3" json:"namespaced_names,omitempty"`
	// contains filtered or unexported fields
}

NamespacedNames

func (*NamespacedNames) Descriptor deprecated 

func (*NamespacedNames) Descriptor() ([]byte, []int)

Deprecated: Use NamespacedNames.ProtoReflect.Descriptor instead.

func (*NamespacedNames) GetNamespacedNames 

func (x *NamespacedNames) GetNamespacedNames() []*NamespacedName

func (*NamespacedNames) ProtoMessage 

func (*NamespacedNames) ProtoMessage()

func (*NamespacedNames) ProtoReflect 

func (x *NamespacedNames) ProtoReflect() protoreflect.Message

func (*NamespacedNames) Reset 

func (x *NamespacedNames) Reset()

func (*NamespacedNames) String 

func (x *NamespacedNames) String() string

type Namespaces 

type Namespaces struct {

	// namespaces
	Namespaces []string `protobuf:"bytes,1,rep,name=namespaces,proto3" json:"namespaces,omitempty"`
	// contains filtered or unexported fields
}

Namespaces, list of namespaces

func (*Namespaces) Descriptor deprecated 

func (*Namespaces) Descriptor() ([]byte, []int)

Deprecated: Use Namespaces.ProtoReflect.Descriptor instead.

func (*Namespaces) GetNamespaces 

func (x *Namespaces) GetNamespaces() []string

func (*Namespaces) ProtoMessage 

func (*Namespaces) ProtoMessage()

func (*Namespaces) ProtoReflect 

func (x *Namespaces) ProtoReflect() protoreflect.Message

func (*Namespaces) Reset 

func (x *Namespaces) Reset()

func (*Namespaces) String 

func (x *Namespaces) String() string

type RestoreChange 

type RestoreChange struct {

	// The full name of the Restore resource that is being modified.
	// Empty for creation.
	// Format: projects/*/locations/*/restorePlans/*/restores/*
	Restore string `protobuf:"bytes,1,opt,name=restore,proto3" json:"restore,omitempty"`
	// Type of the change is being made.
	ChangeType ChangeType `` /* 142-byte string literal not displayed */
	// Modification details.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// The input Restore resource with the updated fields populated to update
	// the source Restore to.
	InputRestore *LoggedRestore `protobuf:"bytes,4,opt,name=input_restore,json=inputRestore,proto3" json:"input_restore,omitempty"`
	// The error code and message.
	Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

use case 4 A log entry when modification(creation, update, deletion) is made to a restore.

func (*RestoreChange) Descriptor deprecated 

func (*RestoreChange) Descriptor() ([]byte, []int)

Deprecated: Use RestoreChange.ProtoReflect.Descriptor instead.

func (*RestoreChange) GetChangeType 

func (x *RestoreChange) GetChangeType() ChangeType

func (*RestoreChange) GetError 

func (x *RestoreChange) GetError() *status.Status

func (*RestoreChange) GetInputRestore 

func (x *RestoreChange) GetInputRestore() *LoggedRestore

func (*RestoreChange) GetRestore 

func (x *RestoreChange) GetRestore() string

func (*RestoreChange) GetUpdateMask 

func (x *RestoreChange) GetUpdateMask() *fieldmaskpb.FieldMask

func (*RestoreChange) ProtoMessage 

func (*RestoreChange) ProtoMessage()

func (*RestoreChange) ProtoReflect 

func (x *RestoreChange) ProtoReflect() protoreflect.Message

func (*RestoreChange) Reset 

func (x *RestoreChange) Reset()

func (*RestoreChange) String 

func (x *RestoreChange) String() string

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 `` /* 212-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 is not empty.
	ClusterResourceConflictPolicy RestoreConfig_ClusterResourceConflictPolicy `` /* 236-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 if
	// any namespaced restoration is configured via
	// namespaced_resource_restore_scope .
	NamespacedResourceRestoreMode RestoreConfig_NamespacedResourceRestoreMode `` /* 236-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.
	//
	// Types that are assignable to NamespacedResourceRestoreScope:
	//	*RestoreConfig_AllNamespaces
	//	*RestoreConfig_SelectedNamespaces
	//	*RestoreConfig_SelectedApplications
	NamespacedResourceRestoreScope isRestoreConfig_NamespacedResourceRestoreScope `protobuf_oneof:"namespaced_resource_restore_scope"`
	// A list of transformation rules to be applied against Kubernetes resources
	// as they are selected for restoration from a Backup. Rules are executed in
	// order defined - this order matters, as changes made by a rule may impact
	// the filtering logic of subsequent rules. An empty list means no
	// substitution will occur.
	SubstitutionRules []*RestoreConfig_SubstitutionRule `protobuf:"bytes,8,rep,name=substitution_rules,json=substitutionRules,proto3" json:"substitution_rules,omitempty"`
	// contains filtered or unexported fields
}

Configuration of a restore.

func (*RestoreConfig) Descriptor deprecated 

func (*RestoreConfig) Descriptor() ([]byte, []int)

Deprecated: Use RestoreConfig.ProtoReflect.Descriptor instead.

func (*RestoreConfig) GetAllNamespaces 

func (x *RestoreConfig) GetAllNamespaces() bool

func (*RestoreConfig) GetClusterResourceConflictPolicy 

func (x *RestoreConfig) GetClusterResourceConflictPolicy() RestoreConfig_ClusterResourceConflictPolicy

func (*RestoreConfig) GetClusterResourceRestoreScope 

func (x *RestoreConfig) GetClusterResourceRestoreScope() *RestoreConfig_ClusterResourceRestoreScope

func (*RestoreConfig) GetNamespacedResourceRestoreMode 

func (x *RestoreConfig) GetNamespacedResourceRestoreMode() RestoreConfig_NamespacedResourceRestoreMode

func (*RestoreConfig) GetNamespacedResourceRestoreScope 

func (m *RestoreConfig) GetNamespacedResourceRestoreScope() isRestoreConfig_NamespacedResourceRestoreScope

func (*RestoreConfig) GetSelectedApplications 

func (x *RestoreConfig) GetSelectedApplications() *NamespacedNames

func (*RestoreConfig) GetSelectedNamespaces 

func (x *RestoreConfig) GetSelectedNamespaces() *Namespaces

func (*RestoreConfig) GetSubstitutionRules 

func (x *RestoreConfig) GetSubstitutionRules() []*RestoreConfig_SubstitutionRule

func (*RestoreConfig) GetVolumeDataRestorePolicy 

func (x *RestoreConfig) GetVolumeDataRestorePolicy() RestoreConfig_VolumeDataRestorePolicy

func (*RestoreConfig) ProtoMessage 

func (*RestoreConfig) ProtoMessage()

func (*RestoreConfig) ProtoReflect 

func (x *RestoreConfig) ProtoReflect() protoreflect.Message

func (*RestoreConfig) Reset 

func (x *RestoreConfig) Reset()

func (*RestoreConfig) String 

func (x *RestoreConfig) String() string

type RestoreConfig_AllNamespaces 

type RestoreConfig_AllNamespaces struct {
	// Restore all namespaced resources in the Backup if set to "True".
	// Specifying this field to "False" is an error.
	AllNamespaces bool `protobuf:"varint,5,opt,name=all_namespaces,json=allNamespaces,proto3,oneof"`
}

type RestoreConfig_ClusterResourceConflictPolicy 

type RestoreConfig_ClusterResourceConflictPolicy int32

Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. 

const (
	// Unspecified. Only allowed if no cluster-scoped resources will be
	// restored.
	RestoreConfig_CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED RestoreConfig_ClusterResourceConflictPolicy = 0
	// Do not attempt to restore the conflicting resource.
	RestoreConfig_USE_EXISTING_VERSION RestoreConfig_ClusterResourceConflictPolicy = 1
	// Delete the existing version before re-creating it from the Backup.
	// Note that this is a dangerous option which could cause unintentional
	// data loss if used inappropriately - for example, deleting a CRD will
	// cause Kubernetes to delete all CRs of that type.
	RestoreConfig_USE_BACKUP_VERSION RestoreConfig_ClusterResourceConflictPolicy = 2
)

func (RestoreConfig_ClusterResourceConflictPolicy) Descriptor 

func (RestoreConfig_ClusterResourceConflictPolicy) Descriptor() protoreflect.EnumDescriptor

func (RestoreConfig_ClusterResourceConflictPolicy) Enum 

func (x RestoreConfig_ClusterResourceConflictPolicy) Enum() *RestoreConfig_ClusterResourceConflictPolicy

func (RestoreConfig_ClusterResourceConflictPolicy) EnumDescriptor deprecated 

func (RestoreConfig_ClusterResourceConflictPolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use RestoreConfig_ClusterResourceConflictPolicy.Descriptor instead.

func (RestoreConfig_ClusterResourceConflictPolicy) Number 

func (x RestoreConfig_ClusterResourceConflictPolicy) Number() protoreflect.EnumNumber

func (RestoreConfig_ClusterResourceConflictPolicy) String 

func (x RestoreConfig_ClusterResourceConflictPolicy) String() string

func (RestoreConfig_ClusterResourceConflictPolicy) Type 

func (RestoreConfig_ClusterResourceConflictPolicy) Type() protoreflect.EnumType

type RestoreConfig_ClusterResourceRestoreScope 

type RestoreConfig_ClusterResourceRestoreScope struct {

	// A list of "types" of cluster-scoped resources to be restored from the
	// Backup.  An empty list means that NO cluster-scoped resources will be
	// restored. Note that Namespaces and PersistentVolume restoration is
	// handled separately and is not governed by this field.
	SelectedGroupKinds []*RestoreConfig_GroupKind `protobuf:"bytes,1,rep,name=selected_group_kinds,json=selectedGroupKinds,proto3" json:"selected_group_kinds,omitempty"`
	// contains filtered or unexported fields
}

Identifies the cluster-scoped resources to restore from the Backup.

func (*RestoreConfig_ClusterResourceRestoreScope) Descriptor deprecated 

func (*RestoreConfig_ClusterResourceRestoreScope) Descriptor() ([]byte, []int)

Deprecated: Use RestoreConfig_ClusterResourceRestoreScope.ProtoReflect.Descriptor instead.

func (*RestoreConfig_ClusterResourceRestoreScope) GetSelectedGroupKinds 

func (x *RestoreConfig_ClusterResourceRestoreScope) GetSelectedGroupKinds() []*RestoreConfig_GroupKind

func (*RestoreConfig_ClusterResourceRestoreScope) ProtoMessage 

func (*RestoreConfig_ClusterResourceRestoreScope) ProtoMessage()

func (*RestoreConfig_ClusterResourceRestoreScope) ProtoReflect 

func (x *RestoreConfig_ClusterResourceRestoreScope) ProtoReflect() protoreflect.Message

func (*RestoreConfig_ClusterResourceRestoreScope) Reset 

func (x *RestoreConfig_ClusterResourceRestoreScope) Reset()

func (*RestoreConfig_ClusterResourceRestoreScope) String 

func (x *RestoreConfig_ClusterResourceRestoreScope) String() string

type RestoreConfig_GroupKind 

type RestoreConfig_GroupKind struct {

	// API group string of a Kubernetes resource, e.g.
	// "apiextensions.k8s.io", "storage.k8s.io", etc.
	// Note: use empty string for core API group
	ResourceGroup string `protobuf:"bytes,1,opt,name=resource_group,json=resourceGroup,proto3" json:"resource_group,omitempty"`
	// Kind of a Kubernetes resource, e.g.
	// "CustomResourceDefinition", "StorageClass", etc.
	ResourceKind string `protobuf:"bytes,2,opt,name=resource_kind,json=resourceKind,proto3" json:"resource_kind,omitempty"`
	// contains filtered or unexported fields
}

This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore.

func (*RestoreConfig_GroupKind) Descriptor deprecated 

func (*RestoreConfig_GroupKind) Descriptor() ([]byte, []int)

Deprecated: Use RestoreConfig_GroupKind.ProtoReflect.Descriptor instead.

func (*RestoreConfig_GroupKind) GetResourceGroup 

func (x *RestoreConfig_GroupKind) GetResourceGroup() string

func (*RestoreConfig_GroupKind) GetResourceKind 

func (x *RestoreConfig_GroupKind) GetResourceKind() string

func (*RestoreConfig_GroupKind) ProtoMessage 

func (*RestoreConfig_GroupKind) ProtoMessage()

func (*RestoreConfig_GroupKind) ProtoReflect 

func (x *RestoreConfig_GroupKind) ProtoReflect() protoreflect.Message

func (*RestoreConfig_GroupKind) Reset 

func (x *RestoreConfig_GroupKind) Reset()

func (*RestoreConfig_GroupKind) String 

func (x *RestoreConfig_GroupKind) String() string

type RestoreConfig_NamespacedResourceRestoreMode 

type RestoreConfig_NamespacedResourceRestoreMode int32

Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster. 

const (
	// Unspecified. Only allowed if no namespaced resources will be restored.
	RestoreConfig_NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED RestoreConfig_NamespacedResourceRestoreMode = 0
	// When conflicting top-level resources (either Namespaces or
	// ProtectedApplications, depending upon the scope) are encountered, this
	// will first trigger a delete of the conflicting resource AND ALL OF ITS
	// REFERENCED RESOURCES (e.g., all resources in the Namespace or all
	// resources referenced by the ProtectedApplication) before restoring the
	// resources from the Backup. This mode should only be used when you are
	// intending to revert some portion of a cluster to an earlier state.
	RestoreConfig_DELETE_AND_RESTORE RestoreConfig_NamespacedResourceRestoreMode = 1
	// If conflicting top-level resources (either Namespaces or
	// ProtectedApplications, depending upon the scope) are encountered at the
	// beginning of a restore process, the Restore will fail.  If a conflict
	// occurs during the restore process itself (e.g., because an out of band
	// process creates conflicting resources), a conflict will be reported.
	RestoreConfig_FAIL_ON_CONFLICT RestoreConfig_NamespacedResourceRestoreMode = 2
)

func (RestoreConfig_NamespacedResourceRestoreMode) Descriptor 

func (RestoreConfig_NamespacedResourceRestoreMode) Descriptor() protoreflect.EnumDescriptor

func (RestoreConfig_NamespacedResourceRestoreMode) Enum 

func (x RestoreConfig_NamespacedResourceRestoreMode) Enum() *RestoreConfig_NamespacedResourceRestoreMode

func (RestoreConfig_NamespacedResourceRestoreMode) EnumDescriptor deprecated 

func (RestoreConfig_NamespacedResourceRestoreMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use RestoreConfig_NamespacedResourceRestoreMode.Descriptor instead.

func (RestoreConfig_NamespacedResourceRestoreMode) Number 

func (x RestoreConfig_NamespacedResourceRestoreMode) Number() protoreflect.EnumNumber

func (RestoreConfig_NamespacedResourceRestoreMode) String 

func (x RestoreConfig_NamespacedResourceRestoreMode) String() string

func (RestoreConfig_NamespacedResourceRestoreMode) Type 

func (RestoreConfig_NamespacedResourceRestoreMode) Type() protoreflect.EnumType

type RestoreConfig_SelectedApplications 

type RestoreConfig_SelectedApplications struct {
	// A list of selected ProtectedApplications to restore. The listed
	// ProtectedApplications and all the resources to which they refer will be
	// restored.
	SelectedApplications *NamespacedNames `protobuf:"bytes,7,opt,name=selected_applications,json=selectedApplications,proto3,oneof"`
}

type RestoreConfig_SelectedNamespaces 

type RestoreConfig_SelectedNamespaces struct {
	// A list of selected Namespaces to restore from the Backup. The listed
	// Namespaces and all resources contained in them will be restored.
	SelectedNamespaces *Namespaces `protobuf:"bytes,6,opt,name=selected_namespaces,json=selectedNamespaces,proto3,oneof"`
}

type RestoreConfig_SubstitutionRule 

type RestoreConfig_SubstitutionRule struct {

	// (Filtering parameter) Any resource subject to substitution must be
	// contained within one of the listed Kubernetes Namespace in the Backup.
	// If this field is not provided, no namespace filtering will be performed
	// (all resources in all Namespaces, including all cluster-scoped resources,
	// will be candidates for substitution).
	// To mix cluster-scoped and namespaced resources in the same rule, use an
	// empty string ("") as one of the target namespaces.
	TargetNamespaces []string `protobuf:"bytes,1,rep,name=target_namespaces,json=targetNamespaces,proto3" json:"target_namespaces,omitempty"`
	// (Filtering parameter) Any resource subject to substitution must belong to
	// one of the listed "types".
	// If this field is not provided, no type filtering will be performed (all
	// resources of all types matching previous filtering parameters will be
	// candidates for substitution).
	TargetGroupKinds []*RestoreConfig_GroupKind `protobuf:"bytes,2,rep,name=target_group_kinds,json=targetGroupKinds,proto3" json:"target_group_kinds,omitempty"`
	// This is a [JSONPath]
	// ([https://kubernetes.io/docs/reference/kubectl/jsonpath/)
	// expression that matches specific fields of candidate
	// resources and it operates as both a filtering parameter (resources that
	// are not matched with this expression will not be candidates for
	// substitution) as well as a field identifier (identifies exactly which
	// fields out of the candidate resources will be modified).
	TargetJsonPath string `protobuf:"bytes,3,opt,name=target_json_path,json=targetJsonPath,proto3" json:"target_json_path,omitempty"`
	// (Filtering parameter) This is a [regular expression]
	// (https://en.wikipedia.org/wiki/Regular_expression)
	// that is compared against the fields matched by the target_json_path
	// expression (and must also have passed the previous filters).
	// Substitution will not be performed against fields whose
	// value does not match this expression. If this field is NOT specified,
	// then ALL fields matched by the target_json_path expression will undergo
	// substitution. Note that an empty (e.g., "", rather than unspecified)
	// value for for this field will only match empty fields.
	OriginalValuePattern string `protobuf:"bytes,4,opt,name=original_value_pattern,json=originalValuePattern,proto3" json:"original_value_pattern,omitempty"`
	// This is the new value to set for any fields that pass the filtering and
	// selection criteria. To remove a value from a Kubernetes resource, either
	// leave this field unspecified, or set it to the empty string ("").
	NewValue string `protobuf:"bytes,5,opt,name=new_value,json=newValue,proto3" json:"new_value,omitempty"`
	// contains filtered or unexported fields
}

A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.

func (*RestoreConfig_SubstitutionRule) Descriptor deprecated 

func (*RestoreConfig_SubstitutionRule) Descriptor() ([]byte, []int)

Deprecated: Use RestoreConfig_SubstitutionRule.ProtoReflect.Descriptor instead.

func (*RestoreConfig_SubstitutionRule) GetNewValue 

func (x *RestoreConfig_SubstitutionRule) GetNewValue() string

func (*RestoreConfig_SubstitutionRule) GetOriginalValuePattern 

func (x *RestoreConfig_SubstitutionRule) GetOriginalValuePattern() string

func (*RestoreConfig_SubstitutionRule) GetTargetGroupKinds 

func (x *RestoreConfig_SubstitutionRule) GetTargetGroupKinds() []*RestoreConfig_GroupKind

func (*RestoreConfig_SubstitutionRule) GetTargetJsonPath 

func (x *RestoreConfig_SubstitutionRule) GetTargetJsonPath() string

func (*RestoreConfig_SubstitutionRule) GetTargetNamespaces 

func (x *RestoreConfig_SubstitutionRule) GetTargetNamespaces() []string

func (*RestoreConfig_SubstitutionRule) ProtoMessage 

func (*RestoreConfig_SubstitutionRule) ProtoMessage()

func (*RestoreConfig_SubstitutionRule) ProtoReflect 

func (x *RestoreConfig_SubstitutionRule) ProtoReflect() protoreflect.Message

func (*RestoreConfig_SubstitutionRule) Reset 

func (x *RestoreConfig_SubstitutionRule) Reset()

func (*RestoreConfig_SubstitutionRule) String 

func (x *RestoreConfig_SubstitutionRule) String() string

type RestoreConfig_VolumeDataRestorePolicy 

type RestoreConfig_VolumeDataRestorePolicy int32

Defines how volume data should be restored 

const (
	// unspecified, default value
	RestoreConfig_VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED RestoreConfig_VolumeDataRestorePolicy = 0
	// For each PVC to be restored, will create a new underlying volume (and PV)
	// from the corresponding VolumeBackup contained within the Backup.
	RestoreConfig_RESTORE_VOLUME_DATA_FROM_BACKUP RestoreConfig_VolumeDataRestorePolicy = 1
	// For each PVC to be restored, attempt to reuse the original PV contained
	// in the Backup (with its original underlying volume).  Note that option
	// is likely only usable when restoring a workload to its original cluster.
	RestoreConfig_REUSE_VOLUME_HANDLE_FROM_BACKUP RestoreConfig_VolumeDataRestorePolicy = 2
	// For each PVC to be restored, PVCs will be created without any particular
	// action to restore data.  In this case, the normal Kubernetes provisioning
	// logic would kick in, and this would likely result in either dynamically
	// provisioning blank PVs or binding to statically provisioned PVs.
	RestoreConfig_NO_VOLUME_DATA_RESTORATION RestoreConfig_VolumeDataRestorePolicy = 3
)

func (RestoreConfig_VolumeDataRestorePolicy) Descriptor 

func (RestoreConfig_VolumeDataRestorePolicy) Descriptor() protoreflect.EnumDescriptor

func (RestoreConfig_VolumeDataRestorePolicy) Enum 

func (x RestoreConfig_VolumeDataRestorePolicy) Enum() *RestoreConfig_VolumeDataRestorePolicy

func (RestoreConfig_VolumeDataRestorePolicy) EnumDescriptor deprecated 

func (RestoreConfig_VolumeDataRestorePolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use RestoreConfig_VolumeDataRestorePolicy.Descriptor instead.

func (RestoreConfig_VolumeDataRestorePolicy) Number 

func (x RestoreConfig_VolumeDataRestorePolicy) Number() protoreflect.EnumNumber

func (RestoreConfig_VolumeDataRestorePolicy) String 

func (x RestoreConfig_VolumeDataRestorePolicy) String() string

func (RestoreConfig_VolumeDataRestorePolicy) Type 

func (RestoreConfig_VolumeDataRestorePolicy) Type() protoreflect.EnumType

type RestorePlanChange 

type RestorePlanChange struct {

	// The full name of the RestorePlan resource that is being modified.
	// Empty for creation.
	// Format: projects/*/locations/*/restorePlans/*
	RestorePlan string `protobuf:"bytes,1,opt,name=restore_plan,json=restorePlan,proto3" json:"restore_plan,omitempty"`
	// Type of the change is being made.
	ChangeType ChangeType `` /* 142-byte string literal not displayed */
	// Modification details.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// The input RestorePlan resource with the updated fields populated to update
	// the source RestorePlan to.
	InputRestorePlan *LoggedRestorePlan `protobuf:"bytes,4,opt,name=input_restore_plan,json=inputRestorePlan,proto3" json:"input_restore_plan,omitempty"`
	// The error code and message.
	Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

use case 3 A log entry when modification(creation, update, deletion) is made to a restorePlan.

func (*RestorePlanChange) Descriptor deprecated 

func (*RestorePlanChange) Descriptor() ([]byte, []int)

Deprecated: Use RestorePlanChange.ProtoReflect.Descriptor instead.

func (*RestorePlanChange) GetChangeType 

func (x *RestorePlanChange) GetChangeType() ChangeType

func (*RestorePlanChange) GetError 

func (x *RestorePlanChange) GetError() *status.Status

func (*RestorePlanChange) GetInputRestorePlan 

func (x *RestorePlanChange) GetInputRestorePlan() *LoggedRestorePlan

func (*RestorePlanChange) GetRestorePlan 

func (x *RestorePlanChange) GetRestorePlan() string

func (*RestorePlanChange) GetUpdateMask 

func (x *RestorePlanChange) GetUpdateMask() *fieldmaskpb.FieldMask

func (*RestorePlanChange) ProtoMessage 

func (*RestorePlanChange) ProtoMessage()

func (*RestorePlanChange) ProtoReflect 

func (x *RestorePlanChange) ProtoReflect() protoreflect.Message

func (*RestorePlanChange) Reset 

func (x *RestorePlanChange) Reset()

func (*RestorePlanChange) String 

func (x *RestorePlanChange) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.