Struct SearchFoldersRequest

#[non_exhaustive]
pub struct SearchFoldersRequest {
    pub page_size: i32,
    pub page_token: String,
    pub query: String,
}

The request message for searching folders.

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.

page_size: i32

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.

page_token: String

Optional. A pagination token returned from a previous call to SearchFolders that indicates from where search should continue.

query: String

Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned.

Query expressions can be used to restrict results based upon displayName, state and parent, where the operators = (:) NOT, AND and OR can be used along with the suffix wildcard symbol *.

The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior.

| Field                   | Description                            |
|-------------------------|----------------------------------------|
| displayName             | Filters by displayName.                |
| parent                  | Filters by parent (for example: folders/123). |
| state, lifecycleState   | Filters by state.                      |

Some example queries are:

• Query displayName=Test* returns Folder resources whose display name starts with “Test”.
• Query state=ACTIVE returns Folder resources with state set to ACTIVE.
• Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource.
• Query parent=folders/123 AND state=ACTIVE returns active Folder resources that have folders/123 as a parent resource.
• Query displayName=\\"Test String\\" returns Folder resources with display names that include both “Test” and “String”.

Implementations

impl SearchFoldersRequest

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

Sets the value of page_size.

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

Sets the value of page_token.

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

Sets the value of query.

Trait Implementations

impl Clone for SearchFoldersRequest

fn clone(&self) -> SearchFoldersRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchFoldersRequest

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

Formats the value using the given formatter.

impl Default for SearchFoldersRequest

fn default() -> SearchFoldersRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchFoldersRequest

where SearchFoldersRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SearchFoldersRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchFoldersRequest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchFoldersRequest