Google Cloud Resource Manager V3 Client - Class SearchFoldersRequest (1.0.2)

Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class SearchFoldersRequest.

The request message for searching folders.

Generated from protobuf message google.cloud.resourcemanager.v3.SearchFoldersRequest

Namespace

Google \ Cloud \ ResourceManager \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ page_size int

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

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

Returns
Type Description
string

setPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$this

getQuery

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".
Returns
Type Description
string

setQuery

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".
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
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".
Returns
Type Description
SearchFoldersRequest