Reference documentation and code samples for the Resource Manager V3 API class Google::Cloud::ResourceManager::V3::ListFoldersRequest.
The ListFolders request message.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#page_size
def page_size() -> ::Integer
Returns
- (::Integer) — Optional. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.
#page_size=
def page_size=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.
Returns
- (::Integer) — Optional. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.
#page_token
def page_token() -> ::String
Returns
-
(::String) — Optional. A pagination token returned from a previous call to
ListFolders
that indicates where this listing should continue from.
#page_token=
def page_token=(value) -> ::String
Parameter
-
value (::String) — Optional. A pagination token returned from a previous call to
ListFolders
that indicates where this listing should continue from.
Returns
-
(::String) — Optional. A pagination token returned from a previous call to
ListFolders
that indicates where this listing should continue from.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The resource name of the organization or folder whose folders are
being listed.
Must be of the form
folders/{folder_id}
ororganizations/{org_id}
. Access to this method is controlled by checking theresourcemanager.folders.list
permission on theparent
.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — Required. The resource name of the organization or folder whose folders are
being listed.
Must be of the form
folders/{folder_id}
ororganizations/{org_id}
. Access to this method is controlled by checking theresourcemanager.folders.list
permission on theparent
.
Returns
-
(::String) — Required. The resource name of the organization or folder whose folders are
being listed.
Must be of the form
folders/{folder_id}
ororganizations/{org_id}
. Access to this method is controlled by checking theresourcemanager.folders.list
permission on theparent
.
#show_deleted
def show_deleted() -> ::Boolean
Returns
- (::Boolean) — Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.
#show_deleted=
def show_deleted=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.
Returns
- (::Boolean) — Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.