Struct B2ListFileVersionsQueryParameters 

pub struct B2ListFileVersionsQueryParameters {
    pub bucket_id: String,
    pub start_file_name: Option<String>,
    pub start_file_id: Option<String>,
    pub max_file_count: Option<NonZeroU32>,
    pub prefix: Option<String>,
    pub delimiter: Option<String>,
}

Fields

bucket_id: String

The bucket to look for file names in.

start_file_name: Option<String>

The first file name to return.
If there are no files with this name, the first version of the file with the first name after the given name will be the first in the list.
If startFileId is also specified, the name-and-id pair is the starting point. If there is a file with the given name and ID, it will be first in the list. Otherwise, the first file version that comes after the given name and ID will be first in the list.

start_file_id: Option<String>

The first file ID to return. startFileName must also be provided if startFileId is specified. (See startFileName)

max_file_count: Option<NonZeroU32>

The maximum number of files to return from this call. The default value is 100, and the maximum is 10000. Passing in 0 means to use the default of 100.


NOTE: b2_list_file_versions is a Class C transaction (see Pricing). The maximum number of files returned per transaction is 1000. If you set maxFileCount to more than 1000 and more than 1000 are returned, the call will be billed as multiple transactions, as if you had made requests in a loop asking for 1000 at a time. For example: if you set maxFileCount to 10000 and 3123 items are returned, you will be billed for 4 Class C transactions.

prefix: Option<String>

Files returned will be limited to those with the given prefix. Defaults to the empty string, which matches all files.

delimiter: Option<String>

Files returned will be limited to those within the top folder, or any one subfolder. Defaults to NULL. Folder names will also be returned. The delimiter character will be used to “break” file names into folders.

Implementations

impl B2ListFileVersionsQueryParameters

pub fn builder() -> B2ListFileVersionsQueryParametersBuilder<((), (), (), (), (), ())>

Create a builder for building B2ListFileVersionsQueryParameters. On the builder, call .bucket_id(...), .start_file_name(...)(optional), .start_file_id(...)(optional), .max_file_count(...)(optional), .prefix(...)(optional), .delimiter(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of B2ListFileVersionsQueryParameters.

Trait Implementations

impl Clone for B2ListFileVersionsQueryParameters

fn clone(&self) -> B2ListFileVersionsQueryParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for B2ListFileVersionsQueryParameters

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

Formats the value using the given formatter.

impl Serialize for B2ListFileVersionsQueryParameters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.