Struct google_cloudresourcemanager2::SearchFoldersRequest

pub struct SearchFoldersRequest {
    pub page_token: Option<String>,
    pub page_size: Option<i32>,
    pub query: Option<String>,
}

The request message for searching folders.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• search folders (request)

Fields

page_token: Option<String>

A pagination token returned from a previous call to SearchFolders that indicates from where search should continue. This field is optional.

page_size: Option<i32>

The maximum number of folders to return in the response. This field is optional.

query: Option<String>

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, lifecycleState 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.

Some example queries are:

• Query displayName=Test* returns Folder resources whose display name starts with "Test".
• Query lifecycleState=ACTIVE returns Folder resources with lifecycleState set to ACTIVE.
• Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource.
• Query parent=folders/123 AND lifecycleState=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".

Trait Implementations

impl RequestValue for SearchFoldersRequest

impl Default for SearchFoldersRequest

fn default() -> SearchFoldersRequest

Returns the "default value" for a type.

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 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<'de> Deserialize<'de> for SearchFoldersRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.