dataservicedeploymentconfigupdate

Contents

• Services

  • DataServiceDeploymentConfigUpdateService

• Messages

  • Config
  • CreateDataServiceDeploymentConfigUpdateRequest
  • DataServiceDeploymentConfigUpdate
  • GetDataServiceDeploymentConfigUpdateRequest
  • ListDataServiceDeploymentConfigUpdatesRequest
  • ListDataServiceDeploymentConfigUpdatesResponse
  • RetryDataServiceDeploymentConfigUpdateRequest
  • Status

• Scalar Value Types

DataServiceDeploymentConfigUpdateService

DataServiceDeploymentConfigUpdateService provides APIs to interact with the data service deployment config update.

CreateDataServiceDeploymentConfigUpdate

rpc CreateDataServiceDeploymentConfigUpdate(CreateDataServiceDeploymentConfigUpdateRequest) DataServiceDeploymentConfigUpdate

CreateDataServiceDeploymentConfigUpdate API creates config update for deployment. (-- api-linter: core::0133::http-method=disabled aip.dev/not-precedent: We need to do this because here we are actually updating deployment config. --)

GetDataServiceDeploymentConfigUpdate

rpc GetDataServiceDeploymentConfigUpdate(GetDataServiceDeploymentConfigUpdateRequest) DataServiceDeploymentConfigUpdate

GetDataServiceDeploymentConfigUpdate API returns a DataService deployment config update by id.

ListDataServiceDeploymentConfigUpdates

rpc ListDataServiceDeploymentConfigUpdates(ListDataServiceDeploymentConfigUpdatesRequest) ListDataServiceDeploymentConfigUpdatesResponse

ListDataServiceDeploymentConfigUpdates API returns a list of data service deployment config updates.

RetryDataServiceDeploymentConfigUpdate

rpc RetryDataServiceDeploymentConfigUpdate(RetryDataServiceDeploymentConfigUpdateRequest) DataServiceDeploymentConfigUpdate

RetryDataServiceDeploymentConfigUpdate API retries a data service deployment config update.

Messages

Config

Config of the desired DataService deployment configuration.

Field	Type	Description
data_service_deployment_meta	public.portworx.common.v1.Meta	Metadata of the DataService deployment resource.
data_service_deployment_config	public.portworx.pds.dataservicedeployment.v1.Config	DataService config represents desired DataService Deployment Configuration.

CreateDataServiceDeploymentConfigUpdateRequest

CreateDataServiceDeploymentConfigUpdateRequest is the request to create a data service deployment config update record containing desired state of dataservice deployment.

Field	Type	Description
data_service_deployment_config_update	DataServiceDeploymentConfigUpdate	DataServiceDeploymentConfigUpdate of the DataService config deployment update request.

DataServiceDeploymentConfigUpdate

DataServiceDeploymentConfigUpdate represents a DataService deployment config update resource.

Field	Type	Description
meta	public.portworx.common.v1.Meta	Metadata of the DataService deployment config update request.
config	Config	Config of the DataService deployment for which config update is requested.
status	Status	Status of the DataService deployment config update.

GetDataServiceDeploymentConfigUpdateRequest

GetDataServiceDeploymentConfigUpdateRequest is the request for GetDataServiceDeploymentConfigUpdate.

Field	Type	Description
id	string	UID of the DataService deployment config update.

ListDataServiceDeploymentConfigUpdatesRequest

ListDataServiceDeploymentConfigUpdatesRequest is the request for ListDataServiceDeploymentConfigUpdates.

Field	Type	Description
data_service_deployment_id	string	UID of the DataService Deployment.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list to be sorted.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination parameters for listing data service deployment config updates.

ListDataServiceDeploymentConfigUpdatesResponse

ListDataServiceDeploymentConfigUpdatesResponse is the response for ListDataServiceDeploymentConfigUpdates.

Field	Type	Description
data_service_deployment_config_updates	repeated DataServiceDeploymentConfigUpdate	List of DataService deployment config updates.
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. --)

RetryDataServiceDeploymentConfigUpdateRequest

RetryDataServiceDeploymentConfigUpdateRequest is the request for RetryDataServiceDeploymentConfigUpdate.

Field	Type	Description
id	string	UID of the DataService deployment config update.

Status

Status of the DataService deployment config update.

Field	Type	Description
error_code	string	Error Code is a short string that represents the error.
error_message	string	Error Message is a description of the error.
retry_count	int32	Number of times the DataService config update has been retried.
phase	Status.Phase	Phase of the DataService deployment config update.

Enums

Status.Phase

Enum for Phase of the DataService deployment config update.

Name	Number	Description
PHASE_UNSPECIFIED	0	Phase is unspecified.
FAILED	1	DataService deployment config update failed.
QUEUED	2	DataService deployment config update is queued.
IN_PROGRESS	3	DataService deployment config update is in progress.
COMPLETED	4	DataService deployment config update is completed.
REQUEUED	5	DataService config update is requeued.

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