Class: Google::Apis::CloudresourcemanagerV2beta1::SearchFoldersRequest
- Inherits:
-
Object
- Object
- Google::Apis::CloudresourcemanagerV2beta1::SearchFoldersRequest
- Defined in:
- generated/google/apis/cloudresourcemanager_v2beta1/classes.rb,
generated/google/apis/cloudresourcemanager_v2beta1/representations.rb,
generated/google/apis/cloudresourcemanager_v2beta1/representations.rb
Overview
The request message for searching folders.
Instance Attribute Summary collapse
-
#page_size ⇒ Fixnum
Optional.
-
#page_token ⇒ String
Optional.
-
#query ⇒ String
Search criteria used to select the Folders to return.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SearchFoldersRequest
constructor
A new instance of SearchFoldersRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ SearchFoldersRequest
Returns a new instance of SearchFoldersRequest.
751 752 753 |
# File 'generated/google/apis/cloudresourcemanager_v2beta1/classes.rb', line 751 def initialize(**args) update!(**args) end |
Instance Attribute Details
#page_size ⇒ Fixnum
Optional. The maximum number of folders to return in the response.
Corresponds to the JSON property pageSize
720 721 722 |
# File 'generated/google/apis/cloudresourcemanager_v2beta1/classes.rb', line 720 def page_size @page_size end |
#page_token ⇒ String
Optional. A pagination token returned from a previous call to SearchFolders
that indicates from where search should continue.
Corresponds to the JSON property pageToken
726 727 728 |
# File 'generated/google/apis/cloudresourcemanager_v2beta1/classes.rb', line 726 def page_token @page_token end |
#query ⇒ String
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 withlifecycleState
set toACTIVE
. - Query
parent=folders/123
returns Folder resources that havefolders/123
as a parent resource. - Query
parent=folders/123 AND lifecycleState=ACTIVE
returns active Folder resources that havefolders/123
as a parent resource. - Query
displayName=\\"Test String\\"
returns Folder resources with display names that include both "Test" and "String". Corresponds to the JSON propertyquery
749 750 751 |
# File 'generated/google/apis/cloudresourcemanager_v2beta1/classes.rb', line 749 def query @query end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
756 757 758 759 760 |
# File 'generated/google/apis/cloudresourcemanager_v2beta1/classes.rb', line 756 def update!(**args) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @query = args[:query] if args.key?(:query) end |