Module types

Source
Expand description

Contains request/response types generated from the API definition of VSS.

Structs§

DeleteObjectRequest
Request payload to be used for DeleteObject API call to server.
DeleteObjectResponse
Server response for DeleteObject API.
EncryptionMetadata
Represents encryption related metadata
ErrorResponse
When HttpStatusCode is not ok (200), the response content contains a serialized ErrorResponse with the relevant ErrorCode and message
GetObjectRequest
Request payload to be used for GetObject API call to server.
GetObjectResponse
Server response for GetObject API.
KeyValue
Represents a key-value pair to be stored or retrieved.
ListKeyVersionsRequest
Request payload to be used for ListKeyVersions API call to server.
ListKeyVersionsResponse
Server response for ListKeyVersions API.
PlaintextBlob
Represents a data blob, which is encrypted, serialized and later used in Storable.data. Since the whole Storable.data is client-side encrypted, the server cannot understand this.
PutObjectRequest
Request payload to be used for PutObject API call to server.
PutObjectResponse
Server response for PutObject API.
Storable
Represents a storable object that can be serialized and stored as value in PutObjectRequest. Only provided as a helper object for ease of use by clients. Clients MUST encrypt the PlaintextBlob before using it as data in Storable. The server does not use or read anything from Storable, Clients may use its fields as required.

Enums§

ErrorCode
ErrorCodes to be used in ErrorResponse