Class: Google::Apis::CloudresourcemanagerV2::SearchFoldersRequest
- Inherits:
-
Object
- Object
- Google::Apis::CloudresourcemanagerV2::SearchFoldersRequest
- Defined in:
- generated/google/apis/cloudresourcemanager_v2/classes.rb,
generated/google/apis/cloudresourcemanager_v2/representations.rb,
generated/google/apis/cloudresourcemanager_v2/representations.rb
Overview
The request message for searching folders.
Instance Attribute Summary collapse
-
#page_size ⇒ Fixnum
The maximum number of folders to return in the response.
-
#page_token ⇒ String
A pagination token returned from a previous call to
SearchFolders
that indicates from where search should continue. -
#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
613 614 615 |
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 613 def initialize(**args) update!(**args) end |
Instance Attribute Details
#page_size ⇒ Fixnum
The maximum number of folders to return in the response.
This field is optional.
Corresponds to the JSON property pageSize
582 583 584 |
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 582 def page_size @page_size end |
#page_token ⇒ String
A pagination token returned from a previous call to SearchFolders
that indicates from where search should continue.
This field is optional.
Corresponds to the JSON property pageToken
589 590 591 |
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 589 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 | Description|
|----- | -----------|
|displayName=Test* | Folders whose display name starts with "Test".|
|lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.|
|parent=folders/123 | Folders whose parent is "folders/123".|
|parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent is
"folders/123".|
|displayName=\"Test String\"|Folders whose display name includes both "Test"
and "String".|
Corresponds to the JSON property query
611 612 613 |
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 611 def query @query end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
618 619 620 621 622 |
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 618 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 |