Class: Google::Cloud::ResourceManager::V3::ListFoldersRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/resourcemanager/v3/folders.rb

Overview

The ListFolders request message.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

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



117
118
119
120
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 117

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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



117
118
119
120
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 117

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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



117
118
119
120
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 117

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#show_deleted ⇒ ::Boolean

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



117
118
119
120
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 117

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end