backup

Contents

• Services

  • BackupService

• Messages

  • Backup
  • Config
  • DataServiceDeploymentMetaData
  • DeleteBackupRequest
  • GetBackupRequest
  • ListBackupsRequest
  • ListBackupsResponse
  • References
  • Status

• Scalar Value Types

BackupService

BackupService serves Backup resource APIs.

GetBackup

rpc GetBackup(GetBackupRequest) Backup

GetBackup API returns the Backup resource.

DeleteBackup

rpc DeleteBackup(DeleteBackupRequest) .google.protobuf.Empty

DeleteBackup API deletes the Backup resource.

ListBackups

rpc ListBackups(ListBackupsRequest) ListBackupsResponse

ListBackups API lists the Backup resources.

Messages

Backup

Resource representing a Data Service Backup.

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

Config

Desired configuration of the Backup.

Field	Type	Description
references	References	References to other objects.
backup_capability	string	BackupCapability of the deployment target when the snapshot was created.

DataServiceDeploymentMetaData

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

Field	Type	Description
name	string	Name of the data service 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.
namespace_name	string	Namespace name to which the backup is associated.
tls_enabled	bool	Flag to check whether Transport Layer Security support is enabled or not.
data_service_name	string	Name of the data service of data service deployment.
data_service_version	string	Name of the version of data service.
image_build	string	build tag of the image for the data service version.

DeleteBackupRequest

Request to delete the Backup resource.

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

GetBackupRequest

Request to get the Backup resource.

Field	Type	Description
id	string	UID of the Backup.

ListBackupsRequest

Request to list the Backup resources.

Field	Type	Description
oneof list_by.data_service_deployment_id	string	Data service Deployment ID for which the backups will be listed.
oneof list_by.backup_config_id	string	Backup Configuration ID for which the backups will be listed.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination parameters for listing backups.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list of backups to be sorted.

ListBackupsResponse

Response to list Backup request.

Field	Type	Description
backups	repeated Backup	List of backup resources.
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 other resources.

Field	Type	Description
image_id	string	UID of the image of the data service which will needs to be backup .

Status

Status of the Backup.

Field	Type	Description
cloud_snap_id	string	CloudSnapID snapshot of the backup volume.
start_time	google.protobuf.Timestamp	Start time of the backup.
completion_time	google.protobuf.Timestamp	Completion time of the backup.
phase	Status.Phase	Phase of the Backup.
error_code	string	ErrorCode if CompletionStatus is "Failed".
error_message	string	ErrorMessage associated with the ErrorCode.
file_size	int64	FileSize of the CloudSnap image.
data_service_deployment_meta_data	DataServiceDeploymentMetaData	DataService Deployment Meta Data.

Enums

Status.Phase

Enum for Phase of the DataService Deployment.

Name	Number	Description
PHASE_UNSPECIFIED	0	Phase is unspecified.
IN_PROGRESS	1	Backup is in_progress.
COMPLETED	2	Backup is completed.
FAILED	3	Backup is failed.

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