Struct vss_client::types::ListKeyVersionsResponse

pub struct ListKeyVersionsResponse {
    pub key_versions: Vec<KeyValue>,
    pub next_page_token: Option<String>,
    pub global_version: Option<i64>,
}

Server response for ListKeyVersions API.

Fields

key_versions: Vec<KeyValue>

Fetched keys and versions. Even though this API reuses the KeyValue struct, the value sub-field will not be set by the server.

next_page_token: Option<String>

next_page_token is a pagination token, used to retrieve the next page of results. Use this value to query for next-page of paginated ListKeyVersions operation, by specifying this value as the page_token in the next request.

If next_page_token is empty (“”), then the “last page” of results has been processed and there is no more data to be retrieved.

If next_page_token is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when next_page_token is empty.

Caution: Clients must not assume a specific number of key_versions to be present in a page for paginated response.

global_version: Option<i64>

global_version is a sequence-number/version of the whole store.

global_version is only returned in response for the first page of the ListKeyVersionsResponse and is guaranteed to be read before reading any key-versions.

In case of refreshing the complete key-version view on the client-side, correct usage for the returned global_version is as following:

1. Read global_version from the first page of paginated response and save it as local variable.
2. Update all the key_versions on client-side from all the pages of paginated response.
3. Update global_version on client_side from the local variable saved in step-1. This ensures that on client-side, all current key_versions were stored at global_version or later. This guarantee is helpful for ensuring the versioning correctness if using the global_version in PutObject API and can help avoid the race conditions related to it.

Implementations

impl ListKeyVersionsResponse

pub fn next_page_token(&self) -> &str

Returns the value of next_page_token, or the default value if next_page_token is unset.

pub fn global_version(&self) -> i64

Returns the value of global_version, or the default value if global_version is unset.

Trait Implementations

impl Clone for ListKeyVersionsResponse

fn clone(&self) -> ListKeyVersionsResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListKeyVersionsResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListKeyVersionsResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListKeyVersionsResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListKeyVersionsResponse

fn eq(&self, other: &ListKeyVersionsResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListKeyVersionsResponse