public sealed class ListFoldersRequest : IMessage<ListFoldersRequest>, IEquatable<ListFoldersRequest>, IDeepCloneable<ListFoldersRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Cloud Resource Manager v3 API class ListFoldersRequest.
The ListFolders request message.
Implements
IMessageListFoldersRequest, IEquatableListFoldersRequest, IDeepCloneableListFoldersRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.ResourceManager.V3Assembly
Google.Cloud.ResourceManager.V3.dll
Constructors
ListFoldersRequest()
public ListFoldersRequest()
ListFoldersRequest(ListFoldersRequest)
public ListFoldersRequest(ListFoldersRequest other)
Parameter | |
---|---|
Name | Description |
other | ListFoldersRequest |
Properties
PageSize
public int PageSize { get; set; }
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.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
Optional. A pagination token returned from a previous call to ListFolders
that indicates where this listing should continue from.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
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
.
Property Value | |
---|---|
Type | Description |
string |
ParentAsResourceName
public IResourceName ParentAsResourceName { get; set; }
IResourceName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
IResourceName |
ShowDeleted
public bool ShowDeleted { get; set; }
Optional. Controls whether folders in the [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state should be returned. Defaults to false.
Property Value | |
---|---|
Type | Description |
bool |