Documentation
¶
Index ¶
- type CreateS3Destination
- type CreateSystemBackupRequest
- type DeleteSystemBackupRequest
- type DiscoverSystemBackupsRequest
- type RestoreSystemBackupRequest
- type S3Destination
- type S3DestinationSync
- type S3DestinationSyncRequest
- type SystemBackupDestination
- type SystemBackupPolicy
- type SystemBackupPolicyCollection
- type SystemBackupRecoveryKey
- type SystemBackupRecoveryKeyStatus
- type SystemBackupRun
- type UpdateBackupPolicy
- type UpdateS3Destination
- type UpdateSystemBackupPolicies
- type UpdateSystemBackupPolicy
- type UploadSystemBackupRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateS3Destination ¶
type CreateS3Destination struct {
Name string `json:"name"`
Endpoint string `json:"endpoint,omitempty"`
Bucket string `json:"bucket"`
Region string `json:"region"`
AccessKeyID string `json:"accessKeyId"`
SecretAccessKey string `json:"secretAccessKey"`
Prefix string `json:"prefix,omitempty"`
UseSSL bool `json:"useSsl"`
ForcePathStyle bool `json:"forcePathStyle"`
}
type CreateSystemBackupRequest ¶
type CreateSystemBackupRequest struct {
Destination SystemBackupDestination `json:"destination,omitempty"`
S3DestinationID string `json:"s3DestinationId,omitempty"`
RecoveryKey string `json:"recoveryKey,omitempty"`
PolicyID string `json:"policyId,omitempty"`
}
type DeleteSystemBackupRequest ¶
type DeleteSystemBackupRequest struct {
RecoveryKey string `json:"recoveryKey,omitempty"`
}
type RestoreSystemBackupRequest ¶
type RestoreSystemBackupRequest struct {
RecoveryKey string `json:"recoveryKey"`
}
type S3Destination ¶
type S3Destination struct {
ID string `json:"id"`
Name string `json:"name"`
Endpoint string `json:"endpoint,omitempty"`
Bucket string `json:"bucket"`
Region string `json:"region"`
AccessKeyID string `json:"accessKeyId"`
Prefix string `json:"prefix,omitempty"`
UseSSL bool `json:"useSsl"`
ForcePathStyle bool `json:"forcePathStyle"`
SecretConfigured bool `json:"secretConfigured"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}
type S3DestinationSync ¶
type S3DestinationSyncRequest ¶
type S3DestinationSyncRequest struct {
Destinations []S3DestinationSync `json:"destinations"`
}
type SystemBackupDestination ¶
type SystemBackupDestination string
const ( SystemBackupDestinationLocal SystemBackupDestination = "local" SystemBackupDestinationS3 SystemBackupDestination = "s3" SystemBackupDestinationLocalS3 SystemBackupDestination = "local_s3" )
type SystemBackupPolicy ¶
type SystemBackupPolicy struct {
ID string `json:"id"`
Enabled bool `json:"enabled"`
Schedule string `json:"schedule"`
RetentionCount int `json:"retentionCount"`
LocalEnabled bool `json:"localEnabled"`
S3Enabled bool `json:"s3Enabled"`
S3DestinationID string `json:"s3DestinationId,omitempty"`
S3DestinationName string `json:"s3DestinationName,omitempty"`
LastRun *SystemBackupRun `json:"lastRun,omitempty"`
}
type SystemBackupPolicyCollection ¶
type SystemBackupPolicyCollection struct {
Policies []SystemBackupPolicy `json:"policies"`
RecoveryKeyStored bool `json:"recoveryKeyStored"`
}
type SystemBackupRecoveryKey ¶
type SystemBackupRecoveryKey struct {
RecoveryKey string `json:"recoveryKey"`
}
type SystemBackupRecoveryKeyStatus ¶
type SystemBackupRecoveryKeyStatus struct {
Configured bool `json:"configured"`
}
type SystemBackupRun ¶
type SystemBackupRun struct {
ID string `json:"id"`
Size int64 `json:"size"`
CreatedAt time.Time `json:"createdAt"`
Status string `json:"status"`
Trigger string `json:"trigger"`
Destination SystemBackupDestination `json:"destination"`
LocalSnapshotID string `json:"localSnapshotId,omitempty"`
RemoteSnapshotID string `json:"remoteSnapshotId,omitempty"`
S3DestinationID string `json:"s3DestinationId,omitempty"`
S3DestinationName string `json:"s3DestinationName,omitempty"`
PolicyID string `json:"policyId,omitempty"`
Error string `json:"error,omitempty"`
}
type UpdateBackupPolicy ¶
type UpdateBackupPolicy struct {
ID string `json:"id,omitempty"`
Enabled bool `json:"enabled"`
Schedule string `json:"schedule"`
RetentionCount int `json:"retentionCount"`
StopContainers bool `json:"stopContainers,omitempty"`
LocalEnabled bool `json:"localEnabled"`
S3Enabled bool `json:"s3Enabled"`
S3DestinationID string `json:"s3DestinationId,omitempty"`
}
UpdateBackupPolicy is the shared policy-update payload for every backup domain; StopContainers only applies to volume backups.
type UpdateS3Destination ¶
type UpdateS3Destination = CreateS3Destination
UpdateS3Destination carries the same connection fields as create; an empty SecretAccessKey keeps the stored secret.
type UpdateSystemBackupPolicies ¶
type UpdateSystemBackupPolicies struct {
Policies []UpdateSystemBackupPolicy `json:"policies"`
}
type UpdateSystemBackupPolicy ¶
type UpdateSystemBackupPolicy = UpdateBackupPolicy
Click to show internal directories.
Click to hide internal directories.