Struct google_api_proto::google::cloud::resourcemanager::v3::SearchFoldersRequest

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

The request message for searching folders.

Fields

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”.

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() -> Self

Returns the “default value” for a type.

impl Message for SearchFoldersRequest

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 SearchFoldersRequest

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