Struct ListFoldersRequest 

#[non_exhaustive]
pub struct ListFoldersRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub prefix: String,
    pub delimiter: String,
    pub lexicographic_start: String,
    pub lexicographic_end: String,
    pub request_id: String,
    /* private fields */
}

Request message for ListFolders. This operation is only applicable to a hierarchical namespace enabled bucket.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parent: String

Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.

page_size: i32

Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.

page_token: String

Optional. A previously-returned page token representing part of the larger set of results to view.

prefix: String

Optional. Filter results to folders whose names begin with this prefix. If set, the value must either be an empty string or end with a ‘/’.

delimiter: String

Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is ‘/’.

lexicographic_start: String

Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

lexicographic_end: String

Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

request_id: String

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Implementations

impl ListFoldersRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = ListFoldersRequest::new().set_parent("example");

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListFoldersRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListFoldersRequest::new().set_page_token("example");

pub fn set_prefix<T: Into<String>>(self, v: T) -> Self

Sets the value of prefix.

Example

let x = ListFoldersRequest::new().set_prefix("example");

pub fn set_delimiter<T: Into<String>>(self, v: T) -> Self

Sets the value of delimiter.

Example

let x = ListFoldersRequest::new().set_delimiter("example");

pub fn set_lexicographic_start<T: Into<String>>(self, v: T) -> Self

Sets the value of lexicographic_start.

Example

let x = ListFoldersRequest::new().set_lexicographic_start("example");

pub fn set_lexicographic_end<T: Into<String>>(self, v: T) -> Self

Sets the value of lexicographic_end.

Example

let x = ListFoldersRequest::new().set_lexicographic_end("example");

pub fn set_request_id<T: Into<String>>(self, v: T) -> Self

Sets the value of request_id.

Example

let x = ListFoldersRequest::new().set_request_id("example");

Trait Implementations

impl Clone for ListFoldersRequest

fn clone(&self) -> ListFoldersRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListFoldersRequest

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

Formats the value using the given formatter.

impl Default for ListFoldersRequest

fn default() -> ListFoldersRequest

Returns the “default value” for a type.

impl Message for ListFoldersRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListFoldersRequest

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