Class FoldersResource.SearchRequest

Search for folders that match specific filter criteria. search() provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission resourcemanager.folders.get.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchFoldersResponse>
CloudResourceManagerBaseServiceRequest<SearchFoldersResponse>
FoldersResource.SearchRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudResourceManager.v3
Assembly: Google.Apis.CloudResourceManager.v3.dll
Syntax
public class FoldersResource.SearchRequest : CloudResourceManagerBaseServiceRequest<SearchFoldersResponse>, IClientServiceRequest<SearchFoldersResponse>, IClientServiceRequest

Constructors

SearchRequest(IClientService)

Constructs a new Search request.

Declaration
public SearchRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudResourceManager.v3.Data.SearchFoldersResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudResourceManager.v3.Data.SearchFoldersResponse>.MethodName

PageSize

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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Query

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

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudResourceManager.v3.Data.SearchFoldersResponse>.RestPath

Methods

InitParameters()

Initializes Search parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements