backupconfig

Contents

• Services

  • BackupConfigService

• Messages

  • BackupConfig
  • BackupPolicy
  • Config
  • CreateBackupConfigRequest
  • DataServiceDeploymentMetaData
  • DeleteBackupConfigRequest
  • GetBackupConfigRequest
  • ListBackupConfigsRequest
  • ListBackupConfigsResponse
  • References
  • Status
  • UpdateBackupConfigRequest
  • UpdateBackupConfigRequest.AnnotationsEntry
  • UpdateBackupConfigRequest.LabelsEntry

• Enums

  • BackupConfigSuspended
  • Config.BackupLevel
  • Config.BackupType
  • Config.ReclaimPolicyType
  • Phase

• Scalar Value Types

BackupConfigService

BackupConfigService serves backup config resource APIs.

GetBackupConfig

rpc GetBackupConfig(GetBackupConfigRequest) BackupConfig

GetBackupConfig API returns the the backup configuration resource.

ListBackupConfigs

rpc ListBackupConfigs(ListBackupConfigsRequest) ListBackupConfigsResponse

ListBackupConfigs API lists all the backup configuration for a data service deployment.

CreateBackupConfig

rpc CreateBackupConfig(CreateBackupConfigRequest) BackupConfig

CreateBackupConfig API creates the backup configuration of the backup.

UpdateBackupConfig

rpc UpdateBackupConfig(UpdateBackupConfigRequest) BackupConfig

UpdateBackupConfig API updates the backup configuration of the backup.

DeleteBackupConfig

rpc DeleteBackupConfig(DeleteBackupConfigRequest) .google.protobuf.Empty

DeleteBackupConfig API deletes the backup configuration.

Messages

BackupConfig

Resource representing the backup configuration for a backup.

Field	Type	Description
meta	public.portworx.common.v1.Meta	Metadata of the backup configuration.
config	Config	Desired config of the backup configuration.
status	Status	Current Status of the backup configuration.

BackupPolicy

BackupPolicy associated with the backup config.

Field	Type	Description
id	string	UID of the backup policy associated with the backup configuration.
resource_version	string	Resource version of the backup policy.

Config

Desired config of the backup configuration.

Field	Type	Description
references	References	References to the associated objects for backup configuration.
backup_policy	BackupPolicy	BackupPolicy associated with the backup config.
suspend	bool	Suspend flag is used to suspend a scheduled backup from creating new backups.
backup_type	Config.BackupType	Backup Type for the backup configuration.
backup_level	Config.BackupLevel	Backup Level for the backup configuration.
reclaim_policy	Config.ReclaimPolicyType	Reclaim Policy decides if the volume snapshots should get deleted when a Backup CR gets deleted.

CreateBackupConfigRequest

Request to create a backup configuration.

Field	Type	Description
project_id	string	(-- api-linter: core::0133::request-required-fields=disabled aip.dev/not-precedent: We really need this field to be required to support creation of the resource in the project context. --) (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We really need this field to be required to support creation of the resource in the project context. --) The parent project id under which backup configuration will be created.
data_service_deployment_id	string	(-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We really need this field to be required to support creation of the resource in the deployment context.. --) (-- api-linter: core::0133::request-required-fields=disabled aip.dev/not-precedent: We really need this field to be required to support creation of the resource in the deployment context.. --) Data service Deployment id associated with the backup configuration.
backup_config	BackupConfig	Backup configuration for the backup.

DataServiceDeploymentMetaData

DataServiceDeployment Meta Data contains the details of the DataService deployment associated with the backup configuration.

Field	Type	Description
name	string	Name of the DataService deployment.
custom_resource_name	string	Custom Resource Name is the kubernetes resource name for the deployment meta data.
target_cluster_name	string	Target cluster Name associated with the backup configuration.
namespace_name	string	Namespace name to which the backup configuration is associated.
tls_enabled	bool	Flag to check whether Transport Layer Security support is enabled or not.

DeleteBackupConfigRequest

Request to delete a backup configuration.

Field	Type	Description
id	string	ID of the backup configuration.
force	bool	Force flag to delete backup configuration from control plane only.

GetBackupConfigRequest

Request to get the backup configuration of the specified backup.

Field	Type	Description
id	string	ID of the backup configuration.

ListBackupConfigsRequest

Request to list all the backup configurations.

Field	Type	Description
oneof list_by.tenant_id	string	Tenant (Organization) ID for which the backup configurations will be listed.
oneof list_by.project_id	string	Project ID for which the backup configurations will be listed.
oneof list_by.target_cluster_id	string	Cluster ID for which the backup configurations will be listed.
oneof list_by.namespace_id	string	Namespace ID for which the backup configurations will be listed.
oneof list_by.data_service_deployment_id	string	Data service Deployment ID for which the backup configurations will be listed.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination metadata for listing backup configuration.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list of backup configurations to be sorted.
suspended	BackupConfigSuspended	Filter backup configs based on suspended flag.

ListBackupConfigsResponse

Response of list of backup configurations.

Field	Type	Description
backup_configs	repeated BackupConfig	The list of backup configurations.
pagination	public.portworx.common.v1.PageBasedPaginationResponse	Pagination metadata for this response. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --)

References

References to the associated resources for backup configuration.

Field	Type	Description
data_service_deployment_id	string	UID of the data service deployment to which the backup configuration belong.
backup_location_id	string	UID of the backup target to which the backup configuration belong.
data_service_id	string	UID of the data service to which the backup configuration belong.

Status

Status for backup configuration.

Field	Type	Description
phase	Phase	Phase specifies the phase of backup CR in target cluster.
custom_resource_name	string	Custom Resource Name is the kubernetes resource name for the backup that is built from ID.
is_backup_policy_synchronized	bool	Flag to check if the backup policy is synchronized or not.
data_service_deployment_meta_data	DataServiceDeploymentMetaData	DataService Deployment Meta Data.
error_code	string	Error code.
error_message	string	Error message.

UpdateBackupConfigRequest

Request to update a backup configuration. (-- api-linter: core::0134::request-resource-required=disabled aip.dev/not-precedent: We need to do this because we don't need the full backup config object for update. --)

Field	Type	Description
id	string	ID of the backup configuration.
suspend	BackupConfigSuspended	Suspend flag is used to suspend or resume a scheduled backup.
labels	map UpdateBackupConfigRequest.LabelsEntry	Labels to apply to the Backup Config object.
annotations	map UpdateBackupConfigRequest.AnnotationsEntry	Annotations for the Backup Config object.

UpdateBackupConfigRequest.AnnotationsEntry

Field	Type	Description
key	string	none
value	string	none

UpdateBackupConfigRequest.LabelsEntry

Field	Type	Description
key	string	none
value	string	none

Enums

BackupConfigSuspended

BackupConfigSuspended to accept value for suspended flag.

Name	Number	Description
BACKUP_CONFIG_SUSPENDED_UNSPECIFIED	0	List all backup configs.
TRUE	1	List only suspended backup configs.
FALSE	2	List only disabled backup configs.

Config.BackupLevel

Enum for Backup Level of the backup configuration.

Name	Number	Description
BACKUP_LEVEL_UNSPECIFIED	0	Unspecified level.
SNAPSHOT	1	Snapshot.
INCREMENTAL	2	Incremental.

Config.BackupType

Enum for Backup Type of the backup configuration.

Name	Number	Description
BACKUP_TYPE_UNSPECIFIED	0	Unspecified type.
ADHOC	1	Adhoc Backup.
SCHEDULED	2	Scheduled Backup.

Config.ReclaimPolicyType

Enum for Reclaim Policy for the backup configuration.

Name	Number	Description
RECLAIM_POLICY_TYPE_UNSPECIFIED	0	Unspecified.
DELETE	1	Delete snapshot.
RETAIN	2	Retain snapshot.

Phase

Enum for Phases of the backup configuration.

Name	Number	Description
PHASE_UNSPECIFIED	0	Unspecified state.
PREPARING	1	Preparing state before creation is successful.
APPLIED	2	Applied state when create/update is successful.
UPDATING	3	Updating state.
FAILED	4	Failed state.
SUSPENDED	5	Suspended state.
DELETING	6	Deleting state.

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str