dataserviceversions¶

Contents¶

DataServiceVersionService serves different versions of data services.

rpc ListDataServiceVersions(ListDataServiceVersionsRequest) ListDataServiceVersionsResponse

ListDataServiceVersions lists all the versions of a data service.

rpc GetDataServiceVersion(GetDataServiceVersionRequest) DataServiceVersion

GetDataServiceVersion returns a data service version.

rpc ListCompatibleDataServiceVersions(ListCompatibleDataServiceVersionsRequest) ListCompatibleDataServiceVersionsResponse

ListCompatibleDataServiceVersions lists all the data service versions compatible with other version of a data service.

CompatibleVersions contains compatibility information for a particular Version.

Field	Type	Description
data_service_id	string	UID of the data service.
data_service_name	string	Name of the data service.
data_service_version_id	string	UID of the data service version.
data_service_version_name	string	Name of the data service version.
latest_compatible_patch	DataServiceVersion	LatestCompatiblePatch contains the highest compatible version that only increases the patch version.
latest_compatible_versions	repeated DataServiceVersion	LatestCompatibleVersions contains the latest patch versions of compatible major/minor versions.
compatible_versions	repeated DataServiceVersion	CompatibleVersions contains all compatible versions.

Version represents a particular version of a data service.

Field	Type	Description
meta	public.portworx.common.v1.Meta	Metadata of the resource.
info	Info	Information related to the version.

GetDataServiceVersionRequest is the request object for GetVersion.

Field	Type	Description
id	string	UID of the version.

Information related to the data service version.

Field	Type	Description
enabled	bool	Enabled indicates if the version is enabled.
revision_id	string	revision ID of the data service version

ListCompatibleDataServiceVersionsRequest is the request for ListCompatibleVersions.

Field	Type	Description
data_service_ids	repeated string	List of UID of the data service for which compatible data service versions are requested.
data_service_version_ids	repeated string	List of UID of the data service version for which compatible versions are requested.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list of data service versions to be sorted.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination parameters for listing compatible data service versions.

ListCompatibleDataServiceVersionsResponse is the response for ListCompatibleDataServiceVersions.

Field	Type	Description
compatible_data_service_versions	repeated CompatibleVersions	List of compatible versions of the data service.
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. --)

ListVersionsRequest is the request object for ListVersions.

Field	Type	Description
data_service_id	string	UID of the data service.
enabled	ListDataServiceVersionsRequest.Enabled	Filter data service versions based on enabled flag.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list of Versions to be sorted.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination parameters for listing versions.

ListDataServiceVersionsResponse is the response object for ListVersions.

Field	Type	Description
data_service_versions	repeated DataServiceVersion	List of versions of the data service.
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. --)

Enabled indicate either list all, enabled only or disabled only versions.

.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