google_api_cloud_resource_manager v0.24.0 GoogleApi.CloudResourceManager.V2.Model.SearchFoldersRequest View Source

The request message for searching folders.

Attributes

  • pageSize (type: integer(), default: nil) - Optional. The maximum number of folders to return in the response.
  • pageToken (type: String.t, default: nil) - Optional. A pagination token returned from a previous call to SearchFolders that indicates from where search should continue.
  • query (type: String.t, default: nil) - 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".

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.CloudResourceManager.V2.Model.SearchFoldersRequest{
  pageSize: integer(),
  pageToken: String.t(),
  query: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.