Resource Manager V3 API - Class Google::Cloud::ResourceManager::V3::ListFoldersRequest (v1.5.0)

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. The server can return fewer folders than requested. 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. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.
Returns
  • (::Integer) — Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. 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 name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

    If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

    Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

    If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

    Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

Returns
  • (::String) — Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

    If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

    Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

#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.