Class: Google::Apis::CloudresourcemanagerV2::SearchFoldersRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchFoldersRequest

Returns a new instance of SearchFoldersRequest



609
610
611
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 609

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

Returns:

  • (Fixnum) 


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

Returns:

  • (String) 


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 *. 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".| Corresponds to the JSON property query

Returns:

  • (String) 


607
608
609
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 607

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



614
615
616
617
618
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 614

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