v1

package
v0.88.9 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 20 Imported by: 5

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package backup/v1 contains the API of Backup services.

Index

Constants

View Source 
const (

	// EventTypeBackupPolicy Created is the type of event fired after a backup policy has been created
	// SubjectID contains the ID of the backup policy.
	EventTypeBackupPolicyCreated = "backup.backuppolicy.created"
	// EventTypeBackupPolicyUpdated is the type of event fired after a backup policy has been updated
	// SubjectID contains the ID of the backup policy.
	// Note that this type of event is also fired when the status of the backup policy has changed.
	EventTypeBackupPolicyUpdated = "backup.backuppolicy.updated"
	// EventTypeBackupPolicyDeleted is the type of event fired after a backup policy has been (marked for) deleted
	// SubjectID contains the ID of the backup policy.
	EventTypeBackupPolicyDeleted = "backup.backuppolicy.deleted"
)
View Source 
const (

	// EventTypeBackupCreated is the type of event fired after a backup has been created
	// SubjectID contains the ID of the backup.
	EventTypeBackupCreated = "backup.backup.created"
	// EventTypeBackupUpdated is the type of event fired after a backup has been updated
	// SubjectID contains the ID of the backup.
	// Note that this type of event is also fired when the status of the backup has changed.
	EventTypeBackupUpdated = "backup.backup.updated"
	// EventTypeBackupDeleted is the type of event fired after a backup has been (marked for) deleted
	// SubjectID contains the ID of the backup.
	EventTypeBackupDeleted = "backup.backup.deleted"
)
View Source 
const (

	// PermissionBackupPolicyList is needed for listing backup policies in a deployment
	PermissionBackupPolicyList = "backup.backuppolicy.list"
	// PermissionBackupPolicyGet is needed for getting individual backup policy in a deployment
	PermissionBackupPolicyGet = "backup.backuppolicy.get"
	// PermissionBackupPolicyCreate is needed for create a backup policy
	PermissionBackupPolicyCreate = "backup.backuppolicy.create"
	// PermissionBackupPolicyUpdate is needed for updating a backup policy
	PermissionBackupPolicyUpdate = "backup.backuppolicy.update"
	// PermissionBackupPolicyDelete is needed for deleting a backup policy
	PermissionBackupPolicyDelete = "backup.backuppolicy.delete"
)
View Source 
const (

	// PermissionBackupList is needed for listing backups in a deployment
	PermissionBackupList = "backup.backup.list"
	// PermissionBackupGet is needed for getting individual backup in a deployment
	PermissionBackupGet = "backup.backup.get"
	// PermissionBackupCreate is needed for create a manual backup (this includes backup upload to cloud)
	PermissionBackupCreate = "backup.backup.create"
	// PermissionBackupUpdate is needed for updating a (manual or created by policy) backup (this includes backup upload/removal from cloud)
	PermissionBackupUpdate = "backup.backup.update"
	// PermissionBackupDownload is needed for downloading a backup
	PermissionBackupDownload = "backup.backup.download"
	// PermissionBackupRestore is needed for restoring a backup
	PermissionBackupRestore = "backup.backup.restore"
	// PermissionBackupDelete is needed for deleting a backup
	PermissionBackupDelete = "backup.backup.delete"
	// PermissionBackupCopy is needed for copying a backup
	PermissionBackupCopy = "backup.backup.copy"
)
View Source 
const (
	// KindBackupPolicy is a constants for the kind of BackupPolicy resources.
	KindBackupPolicy = "BackupPolicy"
	// KindBackup is a constants for the kind of Backup resources.
	KindBackup = "Backup"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "backup/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 2
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 5
)
View Source 
const (

	// PermissionBackupFeatureGet is needed for getting whether or not the backup feature is available for a specific deployment
	PermissionBackupFeatureGet = "backup.feature.get"
)

Variables

View Source 
var (
	ErrInvalidLengthBackup        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowBackup          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupBackup = fmt.Errorf("proto: unexpected end of group")
)

Functions

func BackupPolicyURL 

func BackupPolicyURL(organizationID, projectID, deploymentID, backupPolicyID string) string

BackupPolicyURL creates a resource URL for the BackupPolicy with given ID in given context (as individual IDs).

func BackupPolicyURL2 

func BackupPolicyURL2(deploymentURL, backupPolicyID string) string

BackupPolicyURL2 creates a resource URL for the BackupPolicy with given ID in given context (as base URL).

func BackupURL 

func BackupURL(organizationID, projectID, deploymentID, backupID string) string

BackupURL creates a resource URL for the Backup with given ID in given context (as individual IDs).

func BackupURL2 

func BackupURL2(deploymentURL, backupID string) string

BackupURL2 creates a resource URL for the Backup with given ID in given context (as base URL).

func ForEachBackup 

func ForEachBackup(ctx context.Context, listFunc func(ctx context.Context, req *ListBackupsRequest) (*BackupList, error),
	req ListBackupsRequest, cb BackupCallback) error

ForEachBackup iterates over all backups for a specific deployment, invoking the given callback for each backup.

func ForEachBackupPolicy 

func ForEachBackupPolicy(ctx context.Context, listFunc func(ctx context.Context, req *ListBackupPoliciesRequest) (*BackupPolicyList, error),
	req ListBackupPoliciesRequest, cb BackupPolicyCallback) error

ForEachBackupPolicy iterates over all backup policies for a specific deployment, invoking the given callback for each backup policy.

func RegisterBackupServiceHandler 

func RegisterBackupServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterBackupServiceHandler registers the http handlers for service BackupService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterBackupServiceHandlerClient 

func RegisterBackupServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BackupServiceClient) error

RegisterBackupServiceHandlerClient registers the http handlers for service BackupService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "BackupServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "BackupServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "BackupServiceClient" to call the correct interceptors.

func RegisterBackupServiceHandlerFromEndpoint 

func RegisterBackupServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterBackupServiceHandlerFromEndpoint is same as RegisterBackupServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterBackupServiceHandlerServer 

func RegisterBackupServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BackupServiceServer) error

RegisterBackupServiceHandlerServer registers the http handlers for service BackupService to "mux". UnaryRPC :call BackupServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterBackupServiceServer 

func RegisterBackupServiceServer(s *grpc.Server, srv BackupServiceServer)

Types

type Backup 

type Backup struct {
	// System identifier of the backup.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this resource
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Name of the backup
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the backup
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Identifier of the deployment that owns this backup.
	// After creation, this value cannot be changed.
	DeploymentId string `protobuf:"bytes,5,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Identifier of the backup policy that triggered this backup
	// After creation, this value cannot be changed.
	// If this field is empty, this is a manual backup
	BackupPolicyId string `protobuf:"bytes,6,opt,name=backup_policy_id,json=backupPolicyId,proto3" json:"backup_policy_id,omitempty"`
	// The creation timestamp of the backup (database object)
	// This is a read-only value.
	CreatedAt *types.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// The deletion timestamp of the backup
	// This is a read-only value.
	DeletedAt *types.Timestamp `protobuf:"bytes,8,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"`
	// Set when this backup is deleted.
	// This is a read-only value.
	IsDeleted bool `protobuf:"varint,9,opt,name=is_deleted,json=isDeleted,proto3" json:"is_deleted,omitempty"`
	// The timestamp that this backup will be automatically removed
	// You cannot provide a value in the past,
	// If the field is not set, the backup will not be automatically removed.
	AutoDeletedAt *types.Timestamp `protobuf:"bytes,10,opt,name=auto_deleted_at,json=autoDeletedAt,proto3" json:"auto_deleted_at,omitempty"`
	// Information about the deployment during backup
	DeploymentInfo *Backup_DeploymentInfo `protobuf:"bytes,11,opt,name=deployment_info,json=deploymentInfo,proto3" json:"deployment_info,omitempty"`
	// Upload the backup, created by the backup policy, to an external source.
	// Setting or unsetting this fields after the backup has been created will upload/delete the backup from the external source.
	// Setting this field when status.available = false will result in an error
	Upload bool `protobuf:"varint,12,opt,name=upload,proto3" json:"upload,omitempty"`
	// The timestamp of when the upload boolean has been updated.
	// This is a read-only value.
	UploadUpdatedAt *types.Timestamp `protobuf:"bytes,14,opt,name=upload_updated_at,json=uploadUpdatedAt,proto3" json:"upload_updated_at,omitempty"`
	// Information about a backup download.
	// If this field is set the backup will be downloaded the deployment.
	// This is a read-only field. To set this field please use the DownloadBackup method.
	Download *Backup_DownloadSpec `protobuf:"bytes,13,opt,name=download,proto3" json:"download,omitempty"`
	// Identifier of the user who created this backup.
	// This field is set only for manual backups.
	// This is a read-only value.
	CreatedById string `protobuf:"bytes,15,opt,name=created_by_id,json=createdById,proto3" json:"created_by_id,omitempty"`
	// Status of the actual backup
	Status *Backup_Status `protobuf:"bytes,100,opt,name=status,proto3" json:"status,omitempty"`
	// Identifier of the region in which backup is stored
	// If not set, backup is stored in the same region as of deployment
	// This is a read-only field
	RegionId string `protobuf:"bytes,101,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// Identifier of the backup from which this backup is cloned.
	// If not set, backup is not multi-region backup.
	// This is a read-only field
	SourceBackupId       string   `protobuf:"bytes,102,opt,name=source_backup_id,json=sourceBackupId,proto3" json:"source_backup_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Backup represents a single backup of a deployment.

func (*Backup) Descriptor 

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

func (*Backup) GetAutoDeletedAt 

func (m *Backup) GetAutoDeletedAt() *types.Timestamp

func (*Backup) GetBackupPolicyId 

func (m *Backup) GetBackupPolicyId() string

func (*Backup) GetCreatedAt 

func (m *Backup) GetCreatedAt() *types.Timestamp

func (*Backup) GetCreatedById added in v0.79.18 

func (m *Backup) GetCreatedById() string

func (*Backup) GetDeletedAt 

func (m *Backup) GetDeletedAt() *types.Timestamp

func (*Backup) GetDeploymentId 

func (m *Backup) GetDeploymentId() string

func (*Backup) GetDeploymentInfo 

func (m *Backup) GetDeploymentInfo() *Backup_DeploymentInfo

func (*Backup) GetDescription 

func (m *Backup) GetDescription() string

func (*Backup) GetDownload 

func (m *Backup) GetDownload() *Backup_DownloadSpec

func (*Backup) GetId 

func (m *Backup) GetId() string

func (*Backup) GetIsDeleted 

func (m *Backup) GetIsDeleted() bool

func (*Backup) GetName 

func (m *Backup) GetName() string

func (*Backup) GetRegionId added in v0.74.14 

func (m *Backup) GetRegionId() string

func (*Backup) GetSourceBackupId added in v0.76.4 

func (m *Backup) GetSourceBackupId() string

func (*Backup) GetStatus 

func (m *Backup) GetStatus() *Backup_Status

func (*Backup) GetUpload 

func (m *Backup) GetUpload() bool

func (*Backup) GetUploadUpdatedAt 

func (m *Backup) GetUploadUpdatedAt() *types.Timestamp

func (*Backup) GetUrl 

func (m *Backup) GetUrl() string

func (*Backup) Marshal 

func (m *Backup) Marshal() (dAtA []byte, err error)

func (*Backup) MarshalTo 

func (m *Backup) MarshalTo(dAtA []byte) (int, error)

func (*Backup) MarshalToSizedBuffer 

func (m *Backup) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Backup) ProtoMessage 

func (*Backup) ProtoMessage()

func (*Backup) Reset 

func (m *Backup) Reset()

func (*Backup) Size 

func (m *Backup) Size() (n int)

func (*Backup) SpecEquals 

func (source *Backup) SpecEquals(other *Backup) bool

SpecEquals returns true when source & other have the same specification values Note that several fields, like ID, Name and Description are not checked

func (*Backup) String 

func (m *Backup) String() string

func (*Backup) Unmarshal 

func (m *Backup) Unmarshal(dAtA []byte) error

func (*Backup) XXX_DiscardUnknown 

func (m *Backup) XXX_DiscardUnknown()

func (*Backup) XXX_Marshal 

func (m *Backup) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backup) XXX_Merge 

func (m *Backup) XXX_Merge(src proto.Message)

func (*Backup) XXX_Size 

func (m *Backup) XXX_Size() int

func (*Backup) XXX_Unmarshal 

func (m *Backup) XXX_Unmarshal(b []byte) error

type BackupCallback 

type BackupCallback func(context.Context, *Backup) error

BackupCallback is a callback for individual backup.

type BackupList 

type BackupList struct {
	Items []*Backup `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// Budget for backups
	Budget               *v1.Budget `protobuf:"bytes,2,opt,name=budget,proto3" json:"budget,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

List of backups.

func (*BackupList) Descriptor 

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

func (*BackupList) GetBudget 

func (m *BackupList) GetBudget() *v1.Budget

func (*BackupList) GetItems 

func (m *BackupList) GetItems() []*Backup

func (*BackupList) Marshal 

func (m *BackupList) Marshal() (dAtA []byte, err error)

func (*BackupList) MarshalTo 

func (m *BackupList) MarshalTo(dAtA []byte) (int, error)

func (*BackupList) MarshalToSizedBuffer 

func (m *BackupList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupList) ProtoMessage 

func (*BackupList) ProtoMessage()

func (*BackupList) Reset 

func (m *BackupList) Reset()

func (*BackupList) Size 

func (m *BackupList) Size() (n int)

func (*BackupList) String 

func (m *BackupList) String() string

func (*BackupList) Unmarshal 

func (m *BackupList) Unmarshal(dAtA []byte) error

func (*BackupList) XXX_DiscardUnknown 

func (m *BackupList) XXX_DiscardUnknown()

func (*BackupList) XXX_Marshal 

func (m *BackupList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupList) XXX_Merge 

func (m *BackupList) XXX_Merge(src proto.Message)

func (*BackupList) XXX_Size 

func (m *BackupList) XXX_Size() int

func (*BackupList) XXX_Unmarshal 

func (m *BackupList) XXX_Unmarshal(b []byte) error

type BackupPolicy 

type BackupPolicy struct {
	// System identifier of the backup policy.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this resource
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Name of the backup policy
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the backup policy
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Identifier of the deployment that owns this backup policy.
	// After creation, this value cannot be changed.
	DeploymentId string `protobuf:"bytes,5,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// The creation timestamp of the backup policy
	// This is a read-only value.
	CreatedAt *types.Timestamp `protobuf:"bytes,6,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// The deletion timestamp of the backup policy
	// This is a read-only value.
	DeletedAt *types.Timestamp `protobuf:"bytes,7,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"`
	// Set when this backup policy is deleted.
	// This is a read-only value.
	IsDeleted bool `protobuf:"varint,8,opt,name=is_deleted,json=isDeleted,proto3" json:"is_deleted,omitempty"`
	// Pause this backup policy.
	// If a backup policy is paused, the backup policy will not result in new backups.
	// The backup policy isn't deleted, unsetting this field will resume the creation of backups again.
	IsPaused bool `protobuf:"varint,9,opt,name=is_paused,json=isPaused,proto3" json:"is_paused,omitempty"`
	// The schedule for this backup policy
	Schedule *BackupPolicy_Schedule `protobuf:"bytes,10,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// Upload the backup, created by the backup policy, to an external source.
	Upload bool `protobuf:"varint,11,opt,name=upload,proto3" json:"upload,omitempty"`
	// Backups created by this policy will be automatically deleted after the specified retention period
	// A value of 0 means that backup will never be deleted.
	RetentionPeriod *types.Duration `protobuf:"bytes,12,opt,name=retention_period,json=retentionPeriod,proto3" json:"retention_period,omitempty"`
	// The owners of the organization can be notified by email
	// This field support the following values: "Never|FailureOnly|Always"
	EmailNotification string `protobuf:"bytes,13,opt,name=email_notification,json=emailNotification,proto3" json:"email_notification,omitempty"`
	// If set, this backup policy cannot be deleted.
	// To delete, first update the with locked set to false.
	Locked bool `protobuf:"varint,14,opt,name=locked,proto3" json:"locked,omitempty"`
	// Status of the backup policy
	Status *BackupPolicy_Status `protobuf:"bytes,100,opt,name=status,proto3" json:"status,omitempty"`
	// List of region identifiers where the backup should be uploaded
	// in addition to the region where the deployment is running.
	// If not set, it should be uploaded to the same region as where the deployment is running.
	// This field can be filled-out only for policies where 'upload' is set.
	AdditionalRegionIds  []string `protobuf:"bytes,101,rep,name=additional_region_ids,json=additionalRegionIds,proto3" json:"additional_region_ids,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

BackupPolicy represents a single backup policy for a deployment.

func (*BackupPolicy) Descriptor 

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

func (*BackupPolicy) GetAdditionalRegionIds added in v0.74.14 

func (m *BackupPolicy) GetAdditionalRegionIds() []string

func (*BackupPolicy) GetCreatedAt 

func (m *BackupPolicy) GetCreatedAt() *types.Timestamp

func (*BackupPolicy) GetDeletedAt 

func (m *BackupPolicy) GetDeletedAt() *types.Timestamp

func (*BackupPolicy) GetDeploymentId 

func (m *BackupPolicy) GetDeploymentId() string

func (*BackupPolicy) GetDescription 

func (m *BackupPolicy) GetDescription() string

func (*BackupPolicy) GetEmailNotification 

func (m *BackupPolicy) GetEmailNotification() string

func (*BackupPolicy) GetId 

func (m *BackupPolicy) GetId() string

func (*BackupPolicy) GetIsDeleted 

func (m *BackupPolicy) GetIsDeleted() bool

func (*BackupPolicy) GetIsPaused 

func (m *BackupPolicy) GetIsPaused() bool

func (*BackupPolicy) GetLocked added in v0.47.0 

func (m *BackupPolicy) GetLocked() bool

func (*BackupPolicy) GetName 

func (m *BackupPolicy) GetName() string

func (*BackupPolicy) GetRetentionPeriod 

func (m *BackupPolicy) GetRetentionPeriod() *types.Duration

func (*BackupPolicy) GetSchedule 

func (m *BackupPolicy) GetSchedule() *BackupPolicy_Schedule

func (*BackupPolicy) GetStatus 

func (m *BackupPolicy) GetStatus() *BackupPolicy_Status

func (*BackupPolicy) GetUpload 

func (m *BackupPolicy) GetUpload() bool

func (*BackupPolicy) GetUrl 

func (m *BackupPolicy) GetUrl() string

func (*BackupPolicy) Marshal 

func (m *BackupPolicy) Marshal() (dAtA []byte, err error)

func (*BackupPolicy) MarshalTo 

func (m *BackupPolicy) MarshalTo(dAtA []byte) (int, error)

func (*BackupPolicy) MarshalToSizedBuffer 

func (m *BackupPolicy) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupPolicy) ProtoMessage 

func (*BackupPolicy) ProtoMessage()

func (*BackupPolicy) Reset 

func (m *BackupPolicy) Reset()

func (*BackupPolicy) Size 

func (m *BackupPolicy) Size() (n int)

func (*BackupPolicy) SpecEquals 

func (source *BackupPolicy) SpecEquals(other *BackupPolicy) bool

SpecEquals returns true when source & other have the same specification values Note that several fields, like ID, Name and Description are not checked

func (*BackupPolicy) String 

func (m *BackupPolicy) String() string

func (*BackupPolicy) Unmarshal 

func (m *BackupPolicy) Unmarshal(dAtA []byte) error

func (*BackupPolicy) XXX_DiscardUnknown 

func (m *BackupPolicy) XXX_DiscardUnknown()

func (*BackupPolicy) XXX_Marshal 

func (m *BackupPolicy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupPolicy) XXX_Merge 

func (m *BackupPolicy) XXX_Merge(src proto.Message)

func (*BackupPolicy) XXX_Size 

func (m *BackupPolicy) XXX_Size() int

func (*BackupPolicy) XXX_Unmarshal 

func (m *BackupPolicy) XXX_Unmarshal(b []byte) error

type BackupPolicyCallback 

type BackupPolicyCallback func(context.Context, *BackupPolicy) error

BackupPolicyCallback is a callback for individual backup policy.

type BackupPolicyList 

type BackupPolicyList struct {
	Items []*BackupPolicy `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// Budget for backup policies
	Budget               *v1.Budget `protobuf:"bytes,2,opt,name=budget,proto3" json:"budget,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

List of backup policies.

func (*BackupPolicyList) Descriptor 

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

func (*BackupPolicyList) GetBudget added in v0.73.4 

func (m *BackupPolicyList) GetBudget() *v1.Budget

func (*BackupPolicyList) GetItems 

func (m *BackupPolicyList) GetItems() []*BackupPolicy

func (*BackupPolicyList) Marshal 

func (m *BackupPolicyList) Marshal() (dAtA []byte, err error)

func (*BackupPolicyList) MarshalTo 

func (m *BackupPolicyList) MarshalTo(dAtA []byte) (int, error)

func (*BackupPolicyList) MarshalToSizedBuffer 

func (m *BackupPolicyList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupPolicyList) ProtoMessage 

func (*BackupPolicyList) ProtoMessage()

func (*BackupPolicyList) Reset 

func (m *BackupPolicyList) Reset()

func (*BackupPolicyList) Size 

func (m *BackupPolicyList) Size() (n int)

func (*BackupPolicyList) String 

func (m *BackupPolicyList) String() string

func (*BackupPolicyList) Unmarshal 

func (m *BackupPolicyList) Unmarshal(dAtA []byte) error

func (*BackupPolicyList) XXX_DiscardUnknown 

func (m *BackupPolicyList) XXX_DiscardUnknown()

func (*BackupPolicyList) XXX_Marshal 

func (m *BackupPolicyList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupPolicyList) XXX_Merge 

func (m *BackupPolicyList) XXX_Merge(src proto.Message)

func (*BackupPolicyList) XXX_Size 

func (m *BackupPolicyList) XXX_Size() int

func (*BackupPolicyList) XXX_Unmarshal 

func (m *BackupPolicyList) XXX_Unmarshal(b []byte) error

type BackupPolicy_DailySchedule 

type BackupPolicy_DailySchedule struct {
	// If set, a backup will be created on Mondays.
	Monday bool `protobuf:"varint,1,opt,name=monday,proto3" json:"monday,omitempty"`
	// If set, a backup will be created on Tuesdays.
	Tuesday bool `protobuf:"varint,2,opt,name=tuesday,proto3" json:"tuesday,omitempty"`
	// If set, a backup will be created on Wednesdays.
	Wednesday bool `protobuf:"varint,3,opt,name=wednesday,proto3" json:"wednesday,omitempty"`
	// If set, a backup will be created on Thursdays.
	Thursday bool `protobuf:"varint,4,opt,name=thursday,proto3" json:"thursday,omitempty"`
	// If set, a backup will be created on Fridays.
	Friday bool `protobuf:"varint,5,opt,name=friday,proto3" json:"friday,omitempty"`
	// If set, a backup will be created on Saturdays.
	Saturday bool `protobuf:"varint,6,opt,name=saturday,proto3" json:"saturday,omitempty"`
	// If set, a backup will be created on Sundays.
	Sunday bool `protobuf:"varint,7,opt,name=sunday,proto3" json:"sunday,omitempty"`
	// The (target) time of the schedule
	ScheduleAt           *TimeOfDay `protobuf:"bytes,10,opt,name=schedule_at,json=scheduleAt,proto3" json:"schedule_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

Note: Nested types inside nested types is not supported by the typescript generator

func (*BackupPolicy_DailySchedule) Descriptor 

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

func (*BackupPolicy_DailySchedule) Equals 

func (source *BackupPolicy_DailySchedule) Equals(other *BackupPolicy_DailySchedule) bool

Equals returns true when source & other have the same values

func (*BackupPolicy_DailySchedule) GetFriday 

func (m *BackupPolicy_DailySchedule) GetFriday() bool

func (*BackupPolicy_DailySchedule) GetMonday 

func (m *BackupPolicy_DailySchedule) GetMonday() bool

func (*BackupPolicy_DailySchedule) GetSaturday 

func (m *BackupPolicy_DailySchedule) GetSaturday() bool

func (*BackupPolicy_DailySchedule) GetScheduleAt 

func (m *BackupPolicy_DailySchedule) GetScheduleAt() *TimeOfDay

func (*BackupPolicy_DailySchedule) GetSunday 

func (m *BackupPolicy_DailySchedule) GetSunday() bool

func (*BackupPolicy_DailySchedule) GetThursday 

func (m *BackupPolicy_DailySchedule) GetThursday() bool

func (*BackupPolicy_DailySchedule) GetTuesday 

func (m *BackupPolicy_DailySchedule) GetTuesday() bool

func (*BackupPolicy_DailySchedule) GetWednesday 

func (m *BackupPolicy_DailySchedule) GetWednesday() bool

func (*BackupPolicy_DailySchedule) Marshal 

func (m *BackupPolicy_DailySchedule) Marshal() (dAtA []byte, err error)

func (*BackupPolicy_DailySchedule) MarshalTo 

func (m *BackupPolicy_DailySchedule) MarshalTo(dAtA []byte) (int, error)

func (*BackupPolicy_DailySchedule) MarshalToSizedBuffer 

func (m *BackupPolicy_DailySchedule) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupPolicy_DailySchedule) ProtoMessage 

func (*BackupPolicy_DailySchedule) ProtoMessage()

func (*BackupPolicy_DailySchedule) Reset 

func (m *BackupPolicy_DailySchedule) Reset()

func (*BackupPolicy_DailySchedule) Size 

func (m *BackupPolicy_DailySchedule) Size() (n int)

func (*BackupPolicy_DailySchedule) String 

func (m *BackupPolicy_DailySchedule) String() string

func (*BackupPolicy_DailySchedule) Unmarshal 

func (m *BackupPolicy_DailySchedule) Unmarshal(dAtA []byte) error

func (*BackupPolicy_DailySchedule) XXX_DiscardUnknown 

func (m *BackupPolicy_DailySchedule) XXX_DiscardUnknown()

func (*BackupPolicy_DailySchedule) XXX_Marshal 

func (m *BackupPolicy_DailySchedule) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupPolicy_DailySchedule) XXX_Merge 

func (m *BackupPolicy_DailySchedule) XXX_Merge(src proto.Message)

func (*BackupPolicy_DailySchedule) XXX_Size 

func (m *BackupPolicy_DailySchedule) XXX_Size() int

func (*BackupPolicy_DailySchedule) XXX_Unmarshal 

func (m *BackupPolicy_DailySchedule) XXX_Unmarshal(b []byte) error

type BackupPolicy_HourlySchedule 

type BackupPolicy_HourlySchedule struct {
	// Schedule should run with an interval of the specified hours (1-23)
	ScheduleEveryIntervalHours int32 `` /* 144-byte string literal not displayed */
	// Minutes offset is a minute offset to full hour (0-59) when the backup process should start
	MinutesOffset        int32    `protobuf:"varint,2,opt,name=minutes_offset,json=minutesOffset,proto3" json:"minutes_offset,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Note: Nested types inside nested types is not supported by the typescript generator

func (*BackupPolicy_HourlySchedule) Descriptor 

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

func (*BackupPolicy_HourlySchedule) Equals 

func (source *BackupPolicy_HourlySchedule) Equals(other *BackupPolicy_HourlySchedule) bool

Equals returns true when source & other have the same values

func (*BackupPolicy_HourlySchedule) GetMinutesOffset added in v0.73.9 

func (m *BackupPolicy_HourlySchedule) GetMinutesOffset() int32

func (*BackupPolicy_HourlySchedule) GetScheduleEveryIntervalHours 

func (m *BackupPolicy_HourlySchedule) GetScheduleEveryIntervalHours() int32

func (*BackupPolicy_HourlySchedule) Marshal 

func (m *BackupPolicy_HourlySchedule) Marshal() (dAtA []byte, err error)

func (*BackupPolicy_HourlySchedule) MarshalTo 

func (m *BackupPolicy_HourlySchedule) MarshalTo(dAtA []byte) (int, error)

func (*BackupPolicy_HourlySchedule) MarshalToSizedBuffer 

func (m *BackupPolicy_HourlySchedule) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupPolicy_HourlySchedule) ProtoMessage 

func (*BackupPolicy_HourlySchedule) ProtoMessage()

func (*BackupPolicy_HourlySchedule) Reset 

func (m *BackupPolicy_HourlySchedule) Reset()

func (*BackupPolicy_HourlySchedule) Size 

func (m *BackupPolicy_HourlySchedule) Size() (n int)

func (*BackupPolicy_HourlySchedule) String 

func (m *BackupPolicy_HourlySchedule) String() string

func (*BackupPolicy_HourlySchedule) Unmarshal 

func (m *BackupPolicy_HourlySchedule) Unmarshal(dAtA []byte) error

func (*BackupPolicy_HourlySchedule) XXX_DiscardUnknown 

func (m *BackupPolicy_HourlySchedule) XXX_DiscardUnknown()

func (*BackupPolicy_HourlySchedule) XXX_Marshal 

func (m *BackupPolicy_HourlySchedule) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupPolicy_HourlySchedule) XXX_Merge 

func (m *BackupPolicy_HourlySchedule) XXX_Merge(src proto.Message)

func (*BackupPolicy_HourlySchedule) XXX_Size 

func (m *BackupPolicy_HourlySchedule) XXX_Size() int

func (*BackupPolicy_HourlySchedule) XXX_Unmarshal 

func (m *BackupPolicy_HourlySchedule) XXX_Unmarshal(b []byte) error

type BackupPolicy_MonthlySchedule 

type BackupPolicy_MonthlySchedule struct {
	// Run the backup on the specified day of the month (1-31)
	// Note: Specifying a number larger than some months have days will result in no backup for those months (e.g. 29 for February (unless leap year)).
	DayOfMonth int32 `protobuf:"varint,1,opt,name=day_of_month,json=dayOfMonth,proto3" json:"day_of_month,omitempty"`
	// The (target) time of the schedule
	ScheduleAt           *TimeOfDay `protobuf:"bytes,10,opt,name=schedule_at,json=scheduleAt,proto3" json:"schedule_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

Note: Nested types inside nested types is not supported by the typescript generator

func (*BackupPolicy_MonthlySchedule) Descriptor 

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

func (*BackupPolicy_MonthlySchedule) Equals 

func (source *BackupPolicy_MonthlySchedule) Equals(other *BackupPolicy_MonthlySchedule) bool

Equals returns true when source & other have the same values

func (*BackupPolicy_MonthlySchedule) GetDayOfMonth 

func (m *BackupPolicy_MonthlySchedule) GetDayOfMonth() int32

func (*BackupPolicy_MonthlySchedule) GetScheduleAt 

func (m *BackupPolicy_MonthlySchedule) GetScheduleAt() *TimeOfDay

func (*BackupPolicy_MonthlySchedule) Marshal 

func (m *BackupPolicy_MonthlySchedule) Marshal() (dAtA []byte, err error)

func (*BackupPolicy_MonthlySchedule) MarshalTo 

func (m *BackupPolicy_MonthlySchedule) MarshalTo(dAtA []byte) (int, error)

func (*BackupPolicy_MonthlySchedule) MarshalToSizedBuffer 

func (m *BackupPolicy_MonthlySchedule) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupPolicy_MonthlySchedule) ProtoMessage 

func (*BackupPolicy_MonthlySchedule) ProtoMessage()

func (*BackupPolicy_MonthlySchedule) Reset 

func (m *BackupPolicy_MonthlySchedule) Reset()

func (*BackupPolicy_MonthlySchedule) Size 

func (m *BackupPolicy_MonthlySchedule) Size() (n int)

func (*BackupPolicy_MonthlySchedule) String 

func (m *BackupPolicy_MonthlySchedule) String() string

func (*BackupPolicy_MonthlySchedule) Unmarshal 

func (m *BackupPolicy_MonthlySchedule) Unmarshal(dAtA []byte) error

func (*BackupPolicy_MonthlySchedule) XXX_DiscardUnknown 

func (m *BackupPolicy_MonthlySchedule) XXX_DiscardUnknown()

func (*BackupPolicy_MonthlySchedule) XXX_Marshal 

func (m *BackupPolicy_MonthlySchedule) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupPolicy_MonthlySchedule) XXX_Merge 

func (m *BackupPolicy_MonthlySchedule) XXX_Merge(src proto.Message)

func (*BackupPolicy_MonthlySchedule) XXX_Size 

func (m *BackupPolicy_MonthlySchedule) XXX_Size() int

func (*BackupPolicy_MonthlySchedule) XXX_Unmarshal 

func (m *BackupPolicy_MonthlySchedule) XXX_Unmarshal(b []byte) error

type BackupPolicy_Schedule 

type BackupPolicy_Schedule struct {
	// Schedule type should be one of the following string: "Hourly|Daily|Monthly"
	// The schedule_hourly, schedule_daily or schedule_montly field should be set
	// Setting multiple fields, or inconsistent with this field result in an error during create/update
	ScheduleType string `protobuf:"bytes,1,opt,name=schedule_type,json=scheduleType,proto3" json:"schedule_type,omitempty"`
	// Schedule applies to the selected day of the week
	// This is applicable for Hourly type only, ignored for Daily and Monthly
	HourlySchedule *BackupPolicy_HourlySchedule `protobuf:"bytes,2,opt,name=hourly_schedule,json=hourlySchedule,proto3" json:"hourly_schedule,omitempty"`
	// Schedule applies to the selected day of the week
	// This is applicable for Daily type only, ignored for Hourly and Monthly
	DailySchedule *BackupPolicy_DailySchedule `protobuf:"bytes,3,opt,name=daily_schedule,json=dailySchedule,proto3" json:"daily_schedule,omitempty"`
	// Schedule applies to the selected day of the month
	// This is applicable for Monthly type only, ignored for Hourly and Daily
	MonthlySchedule      *BackupPolicy_MonthlySchedule `protobuf:"bytes,4,opt,name=monthly_schedule,json=monthlySchedule,proto3" json:"monthly_schedule,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                      `json:"-"`
	XXX_unrecognized     []byte                        `json:"-"`
	XXX_sizecache        int32                         `json:"-"`
}

func (*BackupPolicy_Schedule) Descriptor 

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

func (*BackupPolicy_Schedule) Equals 

func (source *BackupPolicy_Schedule) Equals(other *BackupPolicy_Schedule) bool

Equals returns true when source & other have the same values

func (*BackupPolicy_Schedule) GetDailySchedule 

func (m *BackupPolicy_Schedule) GetDailySchedule() *BackupPolicy_DailySchedule

func (*BackupPolicy_Schedule) GetHourlySchedule 

func (m *BackupPolicy_Schedule) GetHourlySchedule() *BackupPolicy_HourlySchedule

func (*BackupPolicy_Schedule) GetMonthlySchedule 

func (m *BackupPolicy_Schedule) GetMonthlySchedule() *BackupPolicy_MonthlySchedule

func (*BackupPolicy_Schedule) GetScheduleType 

func (m *BackupPolicy_Schedule) GetScheduleType() string

func (*BackupPolicy_Schedule) Marshal 

func (m *BackupPolicy_Schedule) Marshal() (dAtA []byte, err error)

func (*BackupPolicy_Schedule) MarshalTo 

func (m *BackupPolicy_Schedule) MarshalTo(dAtA []byte) (int, error)

func (*BackupPolicy_Schedule) MarshalToSizedBuffer 

func (m *BackupPolicy_Schedule) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupPolicy_Schedule) ProtoMessage 

func (*BackupPolicy_Schedule) ProtoMessage()

func (*BackupPolicy_Schedule) Reset 

func (m *BackupPolicy_Schedule) Reset()

func (*BackupPolicy_Schedule) Size 

func (m *BackupPolicy_Schedule) Size() (n int)

func (*BackupPolicy_Schedule) String 

func (m *BackupPolicy_Schedule) String() string

func (*BackupPolicy_Schedule) Unmarshal 

func (m *BackupPolicy_Schedule) Unmarshal(dAtA []byte) error

func (*BackupPolicy_Schedule) XXX_DiscardUnknown 

func (m *BackupPolicy_Schedule) XXX_DiscardUnknown()

func (*BackupPolicy_Schedule) XXX_Marshal 

func (m *BackupPolicy_Schedule) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupPolicy_Schedule) XXX_Merge 

func (m *BackupPolicy_Schedule) XXX_Merge(src proto.Message)

func (*BackupPolicy_Schedule) XXX_Size 

func (m *BackupPolicy_Schedule) XXX_Size() int

func (*BackupPolicy_Schedule) XXX_Unmarshal 

func (m *BackupPolicy_Schedule) XXX_Unmarshal(b []byte) error

type BackupPolicy_Status 

type BackupPolicy_Status struct {
	// The timestamp when the next backup - initiated by this backup policy - will be created
	NextBackup *types.Timestamp `protobuf:"bytes,1,opt,name=next_backup,json=nextBackup,proto3" json:"next_backup,omitempty"`
	// Message in case of failure, otherwise an empty string
	Message              string   `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Status of the backup policy All members of this field are read-only.

func (*BackupPolicy_Status) Descriptor 

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

func (*BackupPolicy_Status) Equals 

func (source *BackupPolicy_Status) Equals(other *BackupPolicy_Status) bool

Equals returns true when source & other have the same values

func (*BackupPolicy_Status) GetMessage 

func (m *BackupPolicy_Status) GetMessage() string

func (*BackupPolicy_Status) GetNextBackup 

func (m *BackupPolicy_Status) GetNextBackup() *types.Timestamp

func (*BackupPolicy_Status) Marshal 

func (m *BackupPolicy_Status) Marshal() (dAtA []byte, err error)

func (*BackupPolicy_Status) MarshalTo 

func (m *BackupPolicy_Status) MarshalTo(dAtA []byte) (int, error)

func (*BackupPolicy_Status) MarshalToSizedBuffer 

func (m *BackupPolicy_Status) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BackupPolicy_Status) ProtoMessage 

func (*BackupPolicy_Status) ProtoMessage()

func (*BackupPolicy_Status) Reset 

func (m *BackupPolicy_Status) Reset()

func (*BackupPolicy_Status) Size 

func (m *BackupPolicy_Status) Size() (n int)

func (*BackupPolicy_Status) String 

func (m *BackupPolicy_Status) String() string

func (*BackupPolicy_Status) Unmarshal 

func (m *BackupPolicy_Status) Unmarshal(dAtA []byte) error

func (*BackupPolicy_Status) XXX_DiscardUnknown 

func (m *BackupPolicy_Status) XXX_DiscardUnknown()

func (*BackupPolicy_Status) XXX_Marshal 

func (m *BackupPolicy_Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupPolicy_Status) XXX_Merge 

func (m *BackupPolicy_Status) XXX_Merge(src proto.Message)

func (*BackupPolicy_Status) XXX_Size 

func (m *BackupPolicy_Status) XXX_Size() int

func (*BackupPolicy_Status) XXX_Unmarshal 

func (m *BackupPolicy_Status) XXX_Unmarshal(b []byte) error

type BackupServiceClient 

type BackupServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// Checks if the backup feature is enabled and available for a specific deployment.
	// Required permissions:
	// - backup.feature.get on the deployment that is identified by the given ID.
	IsBackupFeatureAvailable(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.YesOrNo, error)
	// Checks if the backup upload feature is enabled for a specific deployment.
	// Required permissions:
	// - backup.feature.get on the deployment that is identified by the given ID.
	IsBackupUploadFeatureAvailable(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.YesOrNo, error)
	// Checks if the multi region backup upload feature is enabled for a specific deployment.
	// Required permissions:
	// - backup.feature.get on the deployment that is identified by the given ID.
	IsMultiRegionBackupUploadFeatureAvailable(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.YesOrNo, error)
	// Fetch all backup policies for a specific deployment.
	// Required permissions:
	// - backup.backuppolicy.list on the deployment that owns the backup policies and is identified by the given ID.
	ListBackupPolicies(ctx context.Context, in *ListBackupPoliciesRequest, opts ...grpc.CallOption) (*BackupPolicyList, error)
	// Fetch a backup policy identified by the given ID.
	// Required permissions:
	// - backup.backuppolicy.get on the backup policy identified by the given ID.
	GetBackupPolicy(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*BackupPolicy, error)
	// Create a new backup policy
	// Required permissions:
	// -  backup.backuppolicy.create on the deployment that owns the backup policy and is identified by the given ID.
	CreateBackupPolicy(ctx context.Context, in *BackupPolicy, opts ...grpc.CallOption) (*BackupPolicy, error)
	// Update a backup policy
	// Required permissions:
	// -  backup.backuppolicy.update on the backup policy identified by the given ID.
	UpdateBackupPolicy(ctx context.Context, in *BackupPolicy, opts ...grpc.CallOption) (*BackupPolicy, error)
	// Delete a backup policy identified by the given ID.
	// Note that the backup policy are initially only marked for deletion, no backups will be deleted with this operation.
	// Once all their dependent backups are removed, the backup policy is removed.
	// Required permissions:
	// -  backup.backuppolicy.delete on the backup policy identified by the given ID.
	DeleteBackupPolicy(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Fetch all backups for a specific deployment.
	// Required permissions:
	// - backup.backup.list on the deployment that owns the backup and is identified by the given ID.
	ListBackups(ctx context.Context, in *ListBackupsRequest, opts ...grpc.CallOption) (*BackupList, error)
	// Fetch a backup identified by the given ID.
	// Required permissions:
	// - backup.backup.get on the backup identified by the given ID.
	GetBackup(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*Backup, error)
	// Create a new manual backup
	// Setting the backup_policy_id field in the backup is not allowed
	// Required permissions:
	// -  backup.backup.create on the deployment that owns the backup and is identified by the given ID.
	CreateBackup(ctx context.Context, in *Backup, opts ...grpc.CallOption) (*Backup, error)
	// Update a backup
	// Required permissions:
	// -  backup.backup.update on the backup identified by the given ID.
	UpdateBackup(ctx context.Context, in *Backup, opts ...grpc.CallOption) (*Backup, error)
	// Download a backup identified by the given ID from remote storage to the volumes of the servers of the deployment.
	// This operation can only be executed on backups which have the same number of DB Servers in the backup and the current running cluster.
	// If this backup was already downloaded, another download will be done.
	// If the backup is still available on the cluster there is no need to explicitly download the backup before restoring.
	// This function will return immediately.
	// To track status, please invoke GetBackup and check the .status field inside the returned backup object
	// Required permissions:
	// -  backup.backup.download on the backup identified by the given ID.
	DownloadBackup(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Restore (or recover) a backup identified by the given ID
	// This operation can only be executed on backups where status.available is set and
	// the mayor and minor version of the backup and the current running cluster are the same.
	// This function will return immediately.
	// To track status, please invoke GetDeployment on the data API and check the
	// .status.restoring_backup and .status.restore_backup_status fields inside the returned deployment object
	// Required permissions (both are needed):
	// -  backup.backup.restore on the backup identified by the given ID.
	// -  data.deployment.restore-backup on the deployment that owns this backup
	RestoreBackup(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Delete a backup identified by the given ID, after which removal of any remote storage of the backup is started.
	// Note that the backup are initially only marked for deletion.
	// Once all remote storage for the backup has been removed, the backup itself is removed.
	// Required permissions:
	// -  backup.backup.delete on the backup identified by the given ID.
	DeleteBackup(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Copy a backup manually from source backup to a given region identifier.
	// It is not allowed to copy backup that does not have upload flag set to true
	// Required permissions:
	// - backup.backup.copy on the backup identified by the given ID.
	CopyBackup(ctx context.Context, in *CopyBackupRequest, opts ...grpc.CallOption) (*Backup, error)
}

BackupServiceClient is the client API for BackupService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewBackupServiceClient 

func NewBackupServiceClient(cc *grpc.ClientConn) BackupServiceClient

type BackupServiceServer 

type BackupServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Checks if the backup feature is enabled and available for a specific deployment.
	// Required permissions:
	// - backup.feature.get on the deployment that is identified by the given ID.
	IsBackupFeatureAvailable(context.Context, *v1.IDOptions) (*v1.YesOrNo, error)
	// Checks if the backup upload feature is enabled for a specific deployment.
	// Required permissions:
	// - backup.feature.get on the deployment that is identified by the given ID.
	IsBackupUploadFeatureAvailable(context.Context, *v1.IDOptions) (*v1.YesOrNo, error)
	// Checks if the multi region backup upload feature is enabled for a specific deployment.
	// Required permissions:
	// - backup.feature.get on the deployment that is identified by the given ID.
	IsMultiRegionBackupUploadFeatureAvailable(context.Context, *v1.IDOptions) (*v1.YesOrNo, error)
	// Fetch all backup policies for a specific deployment.
	// Required permissions:
	// - backup.backuppolicy.list on the deployment that owns the backup policies and is identified by the given ID.
	ListBackupPolicies(context.Context, *ListBackupPoliciesRequest) (*BackupPolicyList, error)
	// Fetch a backup policy identified by the given ID.
	// Required permissions:
	// - backup.backuppolicy.get on the backup policy identified by the given ID.
	GetBackupPolicy(context.Context, *v1.IDOptions) (*BackupPolicy, error)
	// Create a new backup policy
	// Required permissions:
	// -  backup.backuppolicy.create on the deployment that owns the backup policy and is identified by the given ID.
	CreateBackupPolicy(context.Context, *BackupPolicy) (*BackupPolicy, error)
	// Update a backup policy
	// Required permissions:
	// -  backup.backuppolicy.update on the backup policy identified by the given ID.
	UpdateBackupPolicy(context.Context, *BackupPolicy) (*BackupPolicy, error)
	// Delete a backup policy identified by the given ID.
	// Note that the backup policy are initially only marked for deletion, no backups will be deleted with this operation.
	// Once all their dependent backups are removed, the backup policy is removed.
	// Required permissions:
	// -  backup.backuppolicy.delete on the backup policy identified by the given ID.
	DeleteBackupPolicy(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Fetch all backups for a specific deployment.
	// Required permissions:
	// - backup.backup.list on the deployment that owns the backup and is identified by the given ID.
	ListBackups(context.Context, *ListBackupsRequest) (*BackupList, error)
	// Fetch a backup identified by the given ID.
	// Required permissions:
	// - backup.backup.get on the backup identified by the given ID.
	GetBackup(context.Context, *v1.IDOptions) (*Backup, error)
	// Create a new manual backup
	// Setting the backup_policy_id field in the backup is not allowed
	// Required permissions:
	// -  backup.backup.create on the deployment that owns the backup and is identified by the given ID.
	CreateBackup(context.Context, *Backup) (*Backup, error)
	// Update a backup
	// Required permissions:
	// -  backup.backup.update on the backup identified by the given ID.
	UpdateBackup(context.Context, *Backup) (*Backup, error)
	// Download a backup identified by the given ID from remote storage to the volumes of the servers of the deployment.
	// This operation can only be executed on backups which have the same number of DB Servers in the backup and the current running cluster.
	// If this backup was already downloaded, another download will be done.
	// If the backup is still available on the cluster there is no need to explicitly download the backup before restoring.
	// This function will return immediately.
	// To track status, please invoke GetBackup and check the .status field inside the returned backup object
	// Required permissions:
	// -  backup.backup.download on the backup identified by the given ID.
	DownloadBackup(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Restore (or recover) a backup identified by the given ID
	// This operation can only be executed on backups where status.available is set and
	// the mayor and minor version of the backup and the current running cluster are the same.
	// This function will return immediately.
	// To track status, please invoke GetDeployment on the data API and check the
	// .status.restoring_backup and .status.restore_backup_status fields inside the returned deployment object
	// Required permissions (both are needed):
	// -  backup.backup.restore on the backup identified by the given ID.
	// -  data.deployment.restore-backup on the deployment that owns this backup
	RestoreBackup(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Delete a backup identified by the given ID, after which removal of any remote storage of the backup is started.
	// Note that the backup are initially only marked for deletion.
	// Once all remote storage for the backup has been removed, the backup itself is removed.
	// Required permissions:
	// -  backup.backup.delete on the backup identified by the given ID.
	DeleteBackup(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Copy a backup manually from source backup to a given region identifier.
	// It is not allowed to copy backup that does not have upload flag set to true
	// Required permissions:
	// - backup.backup.copy on the backup identified by the given ID.
	CopyBackup(context.Context, *CopyBackupRequest) (*Backup, error)
}

BackupServiceServer is the server API for BackupService service.

type Backup_DeploymentInfo 

type Backup_DeploymentInfo struct {
	// ArangoDB version of the deployment during backup.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Servers spec of the deployment during backup.
	Servers *v11.Deployment_ServersSpec `protobuf:"bytes,2,opt,name=servers,proto3" json:"servers,omitempty"`
	// Model of the deployment during backup.
	Model                *v11.Deployment_ModelSpec `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

Information about the deployment during backup All members of this field are read-only.

func (*Backup_DeploymentInfo) Descriptor 

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

func (*Backup_DeploymentInfo) GetModel added in v0.43.3 

func (m *Backup_DeploymentInfo) GetModel() *v11.Deployment_ModelSpec

func (*Backup_DeploymentInfo) GetServers 

func (m *Backup_DeploymentInfo) GetServers() *v11.Deployment_ServersSpec

func (*Backup_DeploymentInfo) GetVersion 

func (m *Backup_DeploymentInfo) GetVersion() string

func (*Backup_DeploymentInfo) Marshal 

func (m *Backup_DeploymentInfo) Marshal() (dAtA []byte, err error)

func (*Backup_DeploymentInfo) MarshalTo 

func (m *Backup_DeploymentInfo) MarshalTo(dAtA []byte) (int, error)

func (*Backup_DeploymentInfo) MarshalToSizedBuffer 

func (m *Backup_DeploymentInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Backup_DeploymentInfo) ProtoMessage 

func (*Backup_DeploymentInfo) ProtoMessage()

func (*Backup_DeploymentInfo) Reset 

func (m *Backup_DeploymentInfo) Reset()

func (*Backup_DeploymentInfo) Size 

func (m *Backup_DeploymentInfo) Size() (n int)

func (*Backup_DeploymentInfo) String 

func (m *Backup_DeploymentInfo) String() string

func (*Backup_DeploymentInfo) Unmarshal 

func (m *Backup_DeploymentInfo) Unmarshal(dAtA []byte) error

func (*Backup_DeploymentInfo) XXX_DiscardUnknown 

func (m *Backup_DeploymentInfo) XXX_DiscardUnknown()

func (*Backup_DeploymentInfo) XXX_Marshal 

func (m *Backup_DeploymentInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backup_DeploymentInfo) XXX_Merge 

func (m *Backup_DeploymentInfo) XXX_Merge(src proto.Message)

func (*Backup_DeploymentInfo) XXX_Size 

func (m *Backup_DeploymentInfo) XXX_Size() int

func (*Backup_DeploymentInfo) XXX_Unmarshal 

func (m *Backup_DeploymentInfo) XXX_Unmarshal(b []byte) error

type Backup_DownloadSpec 

type Backup_DownloadSpec struct {
	// The revision of this DownloadSpec
	Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
	// The timestamp of when the last revision has been updated.
	LastUpdatedAt        *types.Timestamp `protobuf:"bytes,2,opt,name=last_updated_at,json=lastUpdatedAt,proto3" json:"last_updated_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

Information about a backup download. All members of this message are read-only.

func (*Backup_DownloadSpec) Descriptor 

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

func (*Backup_DownloadSpec) Equals 

func (source *Backup_DownloadSpec) Equals(other *Backup_DownloadSpec) bool

Equals returns true when source & other have the same values

func (*Backup_DownloadSpec) GetLastUpdatedAt 

func (m *Backup_DownloadSpec) GetLastUpdatedAt() *types.Timestamp

func (*Backup_DownloadSpec) GetRevision 

func (m *Backup_DownloadSpec) GetRevision() int32

func (*Backup_DownloadSpec) Marshal 

func (m *Backup_DownloadSpec) Marshal() (dAtA []byte, err error)

func (*Backup_DownloadSpec) MarshalTo 

func (m *Backup_DownloadSpec) MarshalTo(dAtA []byte) (int, error)

func (*Backup_DownloadSpec) MarshalToSizedBuffer 

func (m *Backup_DownloadSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Backup_DownloadSpec) ProtoMessage 

func (*Backup_DownloadSpec) ProtoMessage()

func (*Backup_DownloadSpec) Reset 

func (m *Backup_DownloadSpec) Reset()

func (*Backup_DownloadSpec) Size 

func (m *Backup_DownloadSpec) Size() (n int)

func (*Backup_DownloadSpec) String 

func (m *Backup_DownloadSpec) String() string

func (*Backup_DownloadSpec) Unmarshal 

func (m *Backup_DownloadSpec) Unmarshal(dAtA []byte) error

func (*Backup_DownloadSpec) XXX_DiscardUnknown 

func (m *Backup_DownloadSpec) XXX_DiscardUnknown()

func (*Backup_DownloadSpec) XXX_Marshal 

func (m *Backup_DownloadSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backup_DownloadSpec) XXX_Merge 

func (m *Backup_DownloadSpec) XXX_Merge(src proto.Message)

func (*Backup_DownloadSpec) XXX_Size 

func (m *Backup_DownloadSpec) XXX_Size() int

func (*Backup_DownloadSpec) XXX_Unmarshal 

func (m *Backup_DownloadSpec) XXX_Unmarshal(b []byte) error

type Backup_DownloadStatus 

type Backup_DownloadStatus struct {
	// The revision of the used DownloadStatus
	Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
	// Set when the backup has been fully downloaded
	Downloaded bool `protobuf:"varint,2,opt,name=downloaded,proto3" json:"downloaded,omitempty"`
	// The timestamp of when the backup has been fully downloaded.
	DownloadedAt         *types.Timestamp `protobuf:"bytes,3,opt,name=downloaded_at,json=downloadedAt,proto3" json:"downloaded_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

The status of backup download All members of this message are read-only.

func (*Backup_DownloadStatus) Descriptor 

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

func (*Backup_DownloadStatus) Equals 

func (source *Backup_DownloadStatus) Equals(other *Backup_DownloadStatus) bool

Equals returns true when source & other have the same values

func (*Backup_DownloadStatus) GetDownloaded 

func (m *Backup_DownloadStatus) GetDownloaded() bool

func (*Backup_DownloadStatus) GetDownloadedAt 

func (m *Backup_DownloadStatus) GetDownloadedAt() *types.Timestamp

func (*Backup_DownloadStatus) GetRevision 

func (m *Backup_DownloadStatus) GetRevision() int32

func (*Backup_DownloadStatus) Marshal 

func (m *Backup_DownloadStatus) Marshal() (dAtA []byte, err error)

func (*Backup_DownloadStatus) MarshalTo 

func (m *Backup_DownloadStatus) MarshalTo(dAtA []byte) (int, error)

func (*Backup_DownloadStatus) MarshalToSizedBuffer 

func (m *Backup_DownloadStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Backup_DownloadStatus) ProtoMessage 

func (*Backup_DownloadStatus) ProtoMessage()

func (*Backup_DownloadStatus) Reset 

func (m *Backup_DownloadStatus) Reset()

func (*Backup_DownloadStatus) Size 

func (m *Backup_DownloadStatus) Size() (n int)

func (*Backup_DownloadStatus) String 

func (m *Backup_DownloadStatus) String() string

func (*Backup_DownloadStatus) Unmarshal 

func (m *Backup_DownloadStatus) Unmarshal(dAtA []byte) error

func (*Backup_DownloadStatus) XXX_DiscardUnknown 

func (m *Backup_DownloadStatus) XXX_DiscardUnknown()

func (*Backup_DownloadStatus) XXX_Marshal 

func (m *Backup_DownloadStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backup_DownloadStatus) XXX_Merge 

func (m *Backup_DownloadStatus) XXX_Merge(src proto.Message)

func (*Backup_DownloadStatus) XXX_Size 

func (m *Backup_DownloadStatus) XXX_Size() int

func (*Backup_DownloadStatus) XXX_Unmarshal 

func (m *Backup_DownloadStatus) XXX_Unmarshal(b []byte) error

type Backup_Status 

type Backup_Status struct {
	// The creation timestamp of the backup
	CreatedAt *types.Timestamp `protobuf:"bytes,1,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// ArangoDB version of the backup
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// The state of the backup
	// Will be one of the following: "Pending|Unavailable|Scheduled|Download|DownloadError|Downloading|Create|Upload|Uploading|UploadError|Ready|Deleted|Failed"
	State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
	// Set when the backup is failed
	IsFailed bool `protobuf:"varint,4,opt,name=is_failed,json=isFailed,proto3" json:"is_failed,omitempty"`
	// State message
	Message string `protobuf:"bytes,5,opt,name=message,proto3" json:"message,omitempty"`
	// Progress of the backup (upload or download)
	Progress string `protobuf:"bytes,6,opt,name=progress,proto3" json:"progress,omitempty"`
	// Size of the backup (in bytes)
	SizeBytes int64 `protobuf:"varint,7,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// If set the backup is available on the cluster and can be restored
	Available bool `protobuf:"varint,10,opt,name=available,proto3" json:"available,omitempty"`
	// Number of dbservers of the deployment during backup
	Dbservers int32 `protobuf:"varint,11,opt,name=dbservers,proto3" json:"dbservers,omitempty"`
	// Indicates that the backup is available in the external source only.
	// You should download the backup before you can restore it.
	UploadOnly bool `protobuf:"varint,12,opt,name=upload_only,json=uploadOnly,proto3" json:"upload_only,omitempty"`
	// The status of backup upload (if applicable).
	UploadStatus *Backup_UploadStatus `protobuf:"bytes,100,opt,name=upload_status,json=uploadStatus,proto3" json:"upload_status,omitempty"`
	// The status of backup download (if applicable).
	// This field will be set to empty if a new revision of the spec is available
	DownloadStatus       *Backup_DownloadStatus `protobuf:"bytes,101,opt,name=download_status,json=downloadStatus,proto3" json:"download_status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

Status of the actual backup All members of this field are read-only.

func (*Backup_Status) Descriptor 

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

func (*Backup_Status) Equals 

func (source *Backup_Status) Equals(other *Backup_Status) bool

Equals returns true when source & other have the same values

func (*Backup_Status) GetAvailable 

func (m *Backup_Status) GetAvailable() bool

func (*Backup_Status) GetCreatedAt 

func (m *Backup_Status) GetCreatedAt() *types.Timestamp

func (*Backup_Status) GetDbservers 

func (m *Backup_Status) GetDbservers() int32

func (*Backup_Status) GetDownloadStatus 

func (m *Backup_Status) GetDownloadStatus() *Backup_DownloadStatus

func (*Backup_Status) GetIsFailed 

func (m *Backup_Status) GetIsFailed() bool

func (*Backup_Status) GetMessage 

func (m *Backup_Status) GetMessage() string

func (*Backup_Status) GetProgress 

func (m *Backup_Status) GetProgress() string

func (*Backup_Status) GetSizeBytes 

func (m *Backup_Status) GetSizeBytes() int64

func (*Backup_Status) GetState 

func (m *Backup_Status) GetState() string

func (*Backup_Status) GetUploadOnly 

func (m *Backup_Status) GetUploadOnly() bool

func (*Backup_Status) GetUploadStatus 

func (m *Backup_Status) GetUploadStatus() *Backup_UploadStatus

func (*Backup_Status) GetVersion 

func (m *Backup_Status) GetVersion() string

func (*Backup_Status) Marshal 

func (m *Backup_Status) Marshal() (dAtA []byte, err error)

func (*Backup_Status) MarshalTo 

func (m *Backup_Status) MarshalTo(dAtA []byte) (int, error)

func (*Backup_Status) MarshalToSizedBuffer 

func (m *Backup_Status) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Backup_Status) ProtoMessage 

func (*Backup_Status) ProtoMessage()

func (*Backup_Status) Reset 

func (m *Backup_Status) Reset()

func (*Backup_Status) Size 

func (m *Backup_Status) Size() (n int)

func (*Backup_Status) String 

func (m *Backup_Status) String() string

func (*Backup_Status) Unmarshal 

func (m *Backup_Status) Unmarshal(dAtA []byte) error

func (*Backup_Status) XXX_DiscardUnknown 

func (m *Backup_Status) XXX_DiscardUnknown()

func (*Backup_Status) XXX_Marshal 

func (m *Backup_Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backup_Status) XXX_Merge 

func (m *Backup_Status) XXX_Merge(src proto.Message)

func (*Backup_Status) XXX_Size 

func (m *Backup_Status) XXX_Size() int

func (*Backup_Status) XXX_Unmarshal 

func (m *Backup_Status) XXX_Unmarshal(b []byte) error

type Backup_UploadStatus 

type Backup_UploadStatus struct {
	// Set when the backup has been fully uploaded
	Uploaded bool `protobuf:"varint,1,opt,name=uploaded,proto3" json:"uploaded,omitempty"`
	// The timestamp of when the backup has been fully uploaded
	UploadedAt *types.Timestamp `protobuf:"bytes,2,opt,name=uploaded_at,json=uploadedAt,proto3" json:"uploaded_at,omitempty"`
	// Size of the backup in the external source (in bytes)
	SizeBytes            int64    `protobuf:"varint,3,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The status of backup upload All members of this message are read-only.

func (*Backup_UploadStatus) Descriptor 

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

func (*Backup_UploadStatus) Equals 

func (source *Backup_UploadStatus) Equals(other *Backup_UploadStatus) bool

Equals returns true when source & other have the same values

func (*Backup_UploadStatus) GetSizeBytes 

func (m *Backup_UploadStatus) GetSizeBytes() int64

func (*Backup_UploadStatus) GetUploaded 

func (m *Backup_UploadStatus) GetUploaded() bool

func (*Backup_UploadStatus) GetUploadedAt 

func (m *Backup_UploadStatus) GetUploadedAt() *types.Timestamp

func (*Backup_UploadStatus) Marshal 

func (m *Backup_UploadStatus) Marshal() (dAtA []byte, err error)

func (*Backup_UploadStatus) MarshalTo 

func (m *Backup_UploadStatus) MarshalTo(dAtA []byte) (int, error)

func (*Backup_UploadStatus) MarshalToSizedBuffer 

func (m *Backup_UploadStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Backup_UploadStatus) ProtoMessage 

func (*Backup_UploadStatus) ProtoMessage()

func (*Backup_UploadStatus) Reset 

func (m *Backup_UploadStatus) Reset()

func (*Backup_UploadStatus) Size 

func (m *Backup_UploadStatus) Size() (n int)

func (*Backup_UploadStatus) String 

func (m *Backup_UploadStatus) String() string

func (*Backup_UploadStatus) Unmarshal 

func (m *Backup_UploadStatus) Unmarshal(dAtA []byte) error

func (*Backup_UploadStatus) XXX_DiscardUnknown 

func (m *Backup_UploadStatus) XXX_DiscardUnknown()

func (*Backup_UploadStatus) XXX_Marshal 

func (m *Backup_UploadStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backup_UploadStatus) XXX_Merge 

func (m *Backup_UploadStatus) XXX_Merge(src proto.Message)

func (*Backup_UploadStatus) XXX_Size 

func (m *Backup_UploadStatus) XXX_Size() int

func (*Backup_UploadStatus) XXX_Unmarshal 

func (m *Backup_UploadStatus) XXX_Unmarshal(b []byte) error

type CopyBackupRequest added in v0.74.14 

type CopyBackupRequest struct {
	// Identifier of the backup that is to be copied
	// The source backup should have the 'upload' boolean set.
	SourceBackupId string `protobuf:"bytes,1,opt,name=source_backup_id,json=sourceBackupId,proto3" json:"source_backup_id,omitempty"`
	// Identifier of the region where the backup should be copied
	RegionId             string   `protobuf:"bytes,2,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Parameters for copying the backup

func (*CopyBackupRequest) Descriptor added in v0.74.14 

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

func (*CopyBackupRequest) GetRegionId added in v0.74.14 

func (m *CopyBackupRequest) GetRegionId() string

func (*CopyBackupRequest) GetSourceBackupId added in v0.74.14 

func (m *CopyBackupRequest) GetSourceBackupId() string

func (*CopyBackupRequest) Marshal added in v0.74.14 

func (m *CopyBackupRequest) Marshal() (dAtA []byte, err error)

func (*CopyBackupRequest) MarshalTo added in v0.74.14 

func (m *CopyBackupRequest) MarshalTo(dAtA []byte) (int, error)

func (*CopyBackupRequest) MarshalToSizedBuffer added in v0.74.14 

func (m *CopyBackupRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CopyBackupRequest) ProtoMessage added in v0.74.14 

func (*CopyBackupRequest) ProtoMessage()

func (*CopyBackupRequest) Reset added in v0.74.14 

func (m *CopyBackupRequest) Reset()

func (*CopyBackupRequest) Size added in v0.74.14 

func (m *CopyBackupRequest) Size() (n int)

func (*CopyBackupRequest) String added in v0.74.14 

func (m *CopyBackupRequest) String() string

func (*CopyBackupRequest) Unmarshal added in v0.74.14 

func (m *CopyBackupRequest) Unmarshal(dAtA []byte) error

func (*CopyBackupRequest) XXX_DiscardUnknown added in v0.74.14 

func (m *CopyBackupRequest) XXX_DiscardUnknown()

func (*CopyBackupRequest) XXX_Marshal added in v0.74.14 

func (m *CopyBackupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CopyBackupRequest) XXX_Merge added in v0.74.14 

func (m *CopyBackupRequest) XXX_Merge(src proto.Message)

func (*CopyBackupRequest) XXX_Size added in v0.74.14 

func (m *CopyBackupRequest) XXX_Size() int

func (*CopyBackupRequest) XXX_Unmarshal added in v0.74.14 

func (m *CopyBackupRequest) XXX_Unmarshal(b []byte) error

type ListBackupPoliciesRequest 

type ListBackupPoliciesRequest struct {
	// Identifier of the deployment to request the backup policies for.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// If set, the result includes all backup policies, including those who set to deleted,
	// however are not removed from the system currently.
	// If not set, only backup policies not indicated as deleted are returned.
	IncludeDeleted bool `protobuf:"varint,2,opt,name=include_deleted,json=includeDeleted,proto3" json:"include_deleted,omitempty"`
	// Optional common list options, the context_id is ignored
	Options              *v1.ListOptions `protobuf:"bytes,10,opt,name=options,proto3" json:"options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Request arguments for ListBackupPolicies

func (*ListBackupPoliciesRequest) Descriptor 

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

func (*ListBackupPoliciesRequest) GetDeploymentId 

func (m *ListBackupPoliciesRequest) GetDeploymentId() string

func (*ListBackupPoliciesRequest) GetIncludeDeleted 

func (m *ListBackupPoliciesRequest) GetIncludeDeleted() bool

func (*ListBackupPoliciesRequest) GetOptions 

func (m *ListBackupPoliciesRequest) GetOptions() *v1.ListOptions

func (*ListBackupPoliciesRequest) Marshal 

func (m *ListBackupPoliciesRequest) Marshal() (dAtA []byte, err error)

func (*ListBackupPoliciesRequest) MarshalTo 

func (m *ListBackupPoliciesRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListBackupPoliciesRequest) MarshalToSizedBuffer 

func (m *ListBackupPoliciesRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListBackupPoliciesRequest) ProtoMessage 

func (*ListBackupPoliciesRequest) ProtoMessage()

func (*ListBackupPoliciesRequest) Reset 

func (m *ListBackupPoliciesRequest) Reset()

func (*ListBackupPoliciesRequest) Size 

func (m *ListBackupPoliciesRequest) Size() (n int)

func (*ListBackupPoliciesRequest) String 

func (m *ListBackupPoliciesRequest) String() string

func (*ListBackupPoliciesRequest) Unmarshal 

func (m *ListBackupPoliciesRequest) Unmarshal(dAtA []byte) error

func (*ListBackupPoliciesRequest) XXX_DiscardUnknown 

func (m *ListBackupPoliciesRequest) XXX_DiscardUnknown()

func (*ListBackupPoliciesRequest) XXX_Marshal 

func (m *ListBackupPoliciesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListBackupPoliciesRequest) XXX_Merge 

func (m *ListBackupPoliciesRequest) XXX_Merge(src proto.Message)

func (*ListBackupPoliciesRequest) XXX_Size 

func (m *ListBackupPoliciesRequest) XXX_Size() int

func (*ListBackupPoliciesRequest) XXX_Unmarshal 

func (m *ListBackupPoliciesRequest) XXX_Unmarshal(b []byte) error

type ListBackupsRequest 

type ListBackupsRequest struct {
	// Identifier of the deployment to request the backups for.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Request backups that are created at or after this timestamp.
	// This is an optional field.
	From *types.Timestamp `protobuf:"bytes,2,opt,name=from,proto3" json:"from,omitempty"`
	// Request backups that are created before this timestamp.
	// This is an optional field.
	To *types.Timestamp `protobuf:"bytes,3,opt,name=to,proto3" json:"to,omitempty"`
	// If set, only backups that can be recovered from are included in the result.
	// A backup can be recovered from when:
	// - It is available and restorable on the servers of the deployment or
	// - It is uploaded and the upload has finised.
	GoodOnly bool `protobuf:"varint,4,opt,name=good_only,json=goodOnly,proto3" json:"good_only,omitempty"`
	// Optional common list options, the context_id is ignored
	Options *v1.ListOptions `protobuf:"bytes,10,opt,name=options,proto3" json:"options,omitempty"`
	// If set, the results will be sorted by created timestamp.
	SortByCreated bool `protobuf:"varint,20,opt,name=sort_by_created,json=sortByCreated,proto3" json:"sort_by_created,omitempty"`
	// Sort descending (default is ascending).
	SortDescending       bool     `protobuf:"varint,21,opt,name=sort_descending,json=sortDescending,proto3" json:"sort_descending,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request arguments for ListBackups

func (*ListBackupsRequest) Descriptor 

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

func (*ListBackupsRequest) GetDeploymentId 

func (m *ListBackupsRequest) GetDeploymentId() string

func (*ListBackupsRequest) GetFrom 

func (m *ListBackupsRequest) GetFrom() *types.Timestamp

func (*ListBackupsRequest) GetGoodOnly added in v0.45.2 

func (m *ListBackupsRequest) GetGoodOnly() bool

func (*ListBackupsRequest) GetOptions 

func (m *ListBackupsRequest) GetOptions() *v1.ListOptions

func (*ListBackupsRequest) GetSortByCreated added in v0.45.2 

func (m *ListBackupsRequest) GetSortByCreated() bool

func (*ListBackupsRequest) GetSortDescending added in v0.45.2 

func (m *ListBackupsRequest) GetSortDescending() bool

func (*ListBackupsRequest) GetTo 

func (m *ListBackupsRequest) GetTo() *types.Timestamp

func (*ListBackupsRequest) Marshal 

func (m *ListBackupsRequest) Marshal() (dAtA []byte, err error)

func (*ListBackupsRequest) MarshalTo 

func (m *ListBackupsRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListBackupsRequest) MarshalToSizedBuffer 

func (m *ListBackupsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListBackupsRequest) ProtoMessage 

func (*ListBackupsRequest) ProtoMessage()

func (*ListBackupsRequest) Reset 

func (m *ListBackupsRequest) Reset()

func (*ListBackupsRequest) Size 

func (m *ListBackupsRequest) Size() (n int)

func (*ListBackupsRequest) String 

func (m *ListBackupsRequest) String() string

func (*ListBackupsRequest) Unmarshal 

func (m *ListBackupsRequest) Unmarshal(dAtA []byte) error

func (*ListBackupsRequest) XXX_DiscardUnknown 

func (m *ListBackupsRequest) XXX_DiscardUnknown()

func (*ListBackupsRequest) XXX_Marshal 

func (m *ListBackupsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListBackupsRequest) XXX_Merge 

func (m *ListBackupsRequest) XXX_Merge(src proto.Message)

func (*ListBackupsRequest) XXX_Size 

func (m *ListBackupsRequest) XXX_Size() int

func (*ListBackupsRequest) XXX_Unmarshal 

func (m *ListBackupsRequest) XXX_Unmarshal(b []byte) error

type TimeOfDay 

type TimeOfDay struct {
	// Hours part of the time of day (0-23)
	Hours int32 `protobuf:"varint,1,opt,name=hours,proto3" json:"hours,omitempty"`
	// Minutes part of the time of day (0-59)
	Minutes int32 `protobuf:"varint,2,opt,name=minutes,proto3" json:"minutes,omitempty"`
	// The time-zone this time of day applies to (empty means UTC)
	// Names MUST be exactly as defined in RFC-822.
	TimeZone             string   `protobuf:"bytes,3,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TimeOfDay describes a specific moment on a day

func (*TimeOfDay) Descriptor 

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

func (*TimeOfDay) Equals 

func (source *TimeOfDay) Equals(other *TimeOfDay) bool

Equals returns true when source & other have the same values

func (*TimeOfDay) GetHours 

func (m *TimeOfDay) GetHours() int32

func (*TimeOfDay) GetMinutes 

func (m *TimeOfDay) GetMinutes() int32

func (*TimeOfDay) GetTimeZone 

func (m *TimeOfDay) GetTimeZone() string

func (*TimeOfDay) Marshal 

func (m *TimeOfDay) Marshal() (dAtA []byte, err error)

func (*TimeOfDay) MarshalTo 

func (m *TimeOfDay) MarshalTo(dAtA []byte) (int, error)

func (*TimeOfDay) MarshalToSizedBuffer 

func (m *TimeOfDay) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*TimeOfDay) ProtoMessage 

func (*TimeOfDay) ProtoMessage()

func (*TimeOfDay) Reset 

func (m *TimeOfDay) Reset()

func (*TimeOfDay) Size 

func (m *TimeOfDay) Size() (n int)

func (*TimeOfDay) String 

func (m *TimeOfDay) String() string

func (*TimeOfDay) Unmarshal 

func (m *TimeOfDay) Unmarshal(dAtA []byte) error

func (*TimeOfDay) XXX_DiscardUnknown 

func (m *TimeOfDay) XXX_DiscardUnknown()

func (*TimeOfDay) XXX_Marshal 

func (m *TimeOfDay) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TimeOfDay) XXX_Merge 

func (m *TimeOfDay) XXX_Merge(src proto.Message)

func (*TimeOfDay) XXX_Size 

func (m *TimeOfDay) XXX_Size() int

func (*TimeOfDay) XXX_Unmarshal 

func (m *TimeOfDay) XXX_Unmarshal(b []byte) error

type UnimplementedBackupServiceServer 

type UnimplementedBackupServiceServer struct {
}

UnimplementedBackupServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedBackupServiceServer) CopyBackup added in v0.74.14 

func (*UnimplementedBackupServiceServer) CopyBackup(ctx context.Context, req *CopyBackupRequest) (*Backup, error)

func (*UnimplementedBackupServiceServer) CreateBackup 

func (*UnimplementedBackupServiceServer) CreateBackup(ctx context.Context, req *Backup) (*Backup, error)

func (*UnimplementedBackupServiceServer) CreateBackupPolicy 

func (*UnimplementedBackupServiceServer) CreateBackupPolicy(ctx context.Context, req *BackupPolicy) (*BackupPolicy, error)

func (*UnimplementedBackupServiceServer) DeleteBackup 

func (*UnimplementedBackupServiceServer) DeleteBackup(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedBackupServiceServer) DeleteBackupPolicy 

func (*UnimplementedBackupServiceServer) DeleteBackupPolicy(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedBackupServiceServer) DownloadBackup 

func (*UnimplementedBackupServiceServer) DownloadBackup(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedBackupServiceServer) GetAPIVersion 

func (*UnimplementedBackupServiceServer) GetAPIVersion(ctx context.Context, req *v1.Empty) (*v1.Version, error)

func (*UnimplementedBackupServiceServer) GetBackup 

func (*UnimplementedBackupServiceServer) GetBackup(ctx context.Context, req *v1.IDOptions) (*Backup, error)

func (*UnimplementedBackupServiceServer) GetBackupPolicy 

func (*UnimplementedBackupServiceServer) GetBackupPolicy(ctx context.Context, req *v1.IDOptions) (*BackupPolicy, error)

func (*UnimplementedBackupServiceServer) IsBackupFeatureAvailable 

func (*UnimplementedBackupServiceServer) IsBackupFeatureAvailable(ctx context.Context, req *v1.IDOptions) (*v1.YesOrNo, error)

func (*UnimplementedBackupServiceServer) IsBackupUploadFeatureAvailable 

func (*UnimplementedBackupServiceServer) IsBackupUploadFeatureAvailable(ctx context.Context, req *v1.IDOptions) (*v1.YesOrNo, error)

func (*UnimplementedBackupServiceServer) IsMultiRegionBackupUploadFeatureAvailable added in v0.74.14 

func (*UnimplementedBackupServiceServer) IsMultiRegionBackupUploadFeatureAvailable(ctx context.Context, req *v1.IDOptions) (*v1.YesOrNo, error)

func (*UnimplementedBackupServiceServer) ListBackupPolicies 

func (*UnimplementedBackupServiceServer) ListBackupPolicies(ctx context.Context, req *ListBackupPoliciesRequest) (*BackupPolicyList, error)

func (*UnimplementedBackupServiceServer) ListBackups 

func (*UnimplementedBackupServiceServer) ListBackups(ctx context.Context, req *ListBackupsRequest) (*BackupList, error)

func (*UnimplementedBackupServiceServer) RestoreBackup 

func (*UnimplementedBackupServiceServer) RestoreBackup(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedBackupServiceServer) UpdateBackup 

func (*UnimplementedBackupServiceServer) UpdateBackup(ctx context.Context, req *Backup) (*Backup, error)

func (*UnimplementedBackupServiceServer) UpdateBackupPolicy 

func (*UnimplementedBackupServiceServer) UpdateBackupPolicy(ctx context.Context, req *BackupPolicy) (*BackupPolicy, error)

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.