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



691
692
693
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 691

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) 


659
660
661
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 659

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) 


666
667
668
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 666

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 with lifecycleState set to ACTIVE.
  • Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource.
  • Query parent=folders/123 AND lifecycleState=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". Corresponds to the JSON property query

Returns:

  • (String) 


689
690
691
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 689

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



696
697
698
699
700
 
# File 'generated/google/apis/cloudresourcemanager_v2/classes.rb', line 696

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