Struct google_api_proto::google::storage::control::v2::ListFoldersRequest

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,
}

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

Fields

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.

Trait Implementations

impl Clone for ListFoldersRequest

fn clone(&self) -> ListFoldersRequest

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for ListFoldersRequest

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

impl PartialEq for ListFoldersRequest

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