Struct ListSnapshotsRequest 

pub struct ListSnapshotsRequest {
    pub max_entries: i32,
    pub starting_token: String,
    pub source_volume_id: String,
    pub snapshot_id: String,
    pub secrets: BTreeMap<String, String>,
}

List all snapshots on the storage system regardless of how they were created.

Fields

max_entries: i32

If specified (non-zero value), the Plugin MUST NOT return more entries than this number in the response. If the actual number of entries is more than this number, the Plugin MUST set next_token in the response which can be used to get the next page of entries in the subsequent ListSnapshots call. This field is OPTIONAL. If not specified (zero value), it means there is no restriction on the number of entries that can be returned. The value of this field MUST NOT be negative.

starting_token: String

A token to specify where to start paginating. Set this field to next_token returned by a previous ListSnapshots call to get the next page of entries. This field is OPTIONAL. An empty string is equal to an unspecified field value.

source_volume_id: String

Identity information for the source volume. This field is OPTIONAL. It can be used to list snapshots by volume.

snapshot_id: String

Identity information for a specific snapshot. This field is OPTIONAL. It can be used to list only a specific snapshot. ListSnapshots will return with current snapshot information and will not block if the snapshot is being processed after it is cut.

secrets: BTreeMap<String, String>

Secrets required by plugin to complete ListSnapshot request. This field is OPTIONAL. Refer to the Secrets Requirements section on how to use this field.

Trait Implementations

impl Clone for ListSnapshotsRequest

fn clone(&self) -> ListSnapshotsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListSnapshotsRequest

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

Formats the value using the given formatter.

impl Default for ListSnapshotsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListSnapshotsRequest

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 ListSnapshotsRequest

fn eq(&self, other: &ListSnapshotsRequest) -> 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 ListSnapshotsRequest