dataservices¶

Contents¶

Services
- DataServicesService
Messages
Scalar Value Types

DataServicesService¶

DataServicesService serves the catalog information about the supported data services.

GetDataService¶

rpc GetDataService(GetDataServiceRequest) DataService

GetDataService API returns the the data service resource.

ListDataServices¶

rpc ListDataServices(ListDataServicesRequest) ListDataServicesResponse

ListDataServices API lists the the data service resources.

Messages¶

DataService¶

A data service is a independent, loosely coupled function that calculate information collected and saved in data storage volumes.

Field	Type	Description
meta	public.portworx.common.v1.Meta	Metadata of the data service.
info	Info	Desired info of the data service.

GetDataServiceRequest¶

Request to get the data service resource.

Field	Type	Description
id	string	UID of the Data Service.

Info¶

Desired Info of the data service.

Field	Type	Description
short_name	string	Short name of the data service.
enabled	bool	Enabled flag suggests if the data service is enabled or not.
node_restrictions	NodeRestrictions	Node restrictions.

ListDataServicesRequest¶

Request to list the data service resources.

Field	Type	Description
enabled	ListDataServicesRequest.Enabled	Filter data services based on enabled flag.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list of data services are to be sorted.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination parameters for listing data services.

ListDataServicesResponse¶

Response for listing data service.

Field	Type	Description
data_services	repeated DataService	List of data service resources.
pagination	public.portworx.common.v1.PageBasedPaginationResponse	(-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --) Pagination metadata for this response.

NodeRestrictions¶

Node Restrictions defines the number of replicas of data service on which the restrictions are imposed. Eg: allowed_sizes = [1,2,4,6]; downsize_enabled = true; resize_disabled_sizes = [2].

Field	Type	Description
allowed_sizes	repeated int64	List of all allowed node sizes.
downsize_enabled	bool	Flag to determine whether downsizing the cluster is enabled during editing.
resize_disabled_sizes	repeated int64	List of all node sizes that are not allowed to change during editing.

Enums¶

ListDataServicesRequest.Enabled¶

Enabled indicate list either all, enabled only or disabled only data services.

Name	Number	Description
ENABLED_UNSPECIFIED	0	List all data services.
TRUE	1	List only enabled data services.
FALSE	2	List only disabled data services.

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