Struct ListKeyVersionsRequest

pub struct ListKeyVersionsRequest {
    pub store_id: String,
    pub key_prefix: Option<String>,
    pub page_size: Option<i32>,
    pub page_token: Option<String>,
}

Request payload to be used for ListKeyVersions API call to server.

Fields

store_id: String

store_id is a keyspace identifier. Ref: https://en.wikipedia.org/wiki/Keyspace_(distributed_data_store) All APIs operate within a single store_id. It is up to clients to use single or multiple stores for their use-case. This can be used for client-isolation/ rate-limiting / throttling on the server-side. Authorization and billing can also be performed at the store_id level.

key_prefix: Option<String>

A key_prefix is a string of characters at the beginning of the key. Prefixes can be used as a way to organize key-values in a similar way to directories.

If key_prefix is specified, the response results will be limited to those keys that begin with the specified prefix.

If no key_prefix is specified or it is empty (“”), all the keys are eligible to be returned in the response.

page_size: Option<i32>

page_size is used by clients to specify the maximum number of results that can be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0 or not set, the server will decide the number of results to be returned.

page_token: Option<String>

page_token is a pagination token.

To query for the first page of ListKeyVersions, page_token must not be specified.

For subsequent pages, use the value that was returned as next_page_token in the previous page’s ListKeyVersionsResponse.

Implementations

impl ListKeyVersionsRequest

pub fn key_prefix(&self) -> &str

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

pub fn page_size(&self) -> i32

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

pub fn page_token(&self) -> &str

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

Trait Implementations

impl Clone for ListKeyVersionsRequest

fn clone(&self) -> ListKeyVersionsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListKeyVersionsRequest

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

Formats the value using the given formatter.

impl Default for ListKeyVersionsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListKeyVersionsRequest

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 ListKeyVersionsRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListKeyVersionsRequest