Interface SearchFoldersRequestOrBuilder (1.53.0)

Version 1.53.0

• 1.55.0 (latest)
• 1.54.0
• 1.53.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.12

public interface SearchFoldersRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract int 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.

int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

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

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getQuery()

public abstract String 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".

string query = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

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

string query = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for query.