Cloud Resource Manager v3 API - Class FoldersClientImpl (2.5.0) 

public sealed class FoldersClientImpl : FoldersClient

Reference documentation and code samples for the Cloud Resource Manager v3 API class FoldersClientImpl.

Folders client wrapper implementation, for convenient use.

Inheritance

object > FoldersClient > FoldersClientImpl

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Remarks

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

Constructors

FoldersClientImpl(FoldersClient, FoldersSettings, ILogger)

public FoldersClientImpl(Folders.FoldersClient grpcClient, FoldersSettings settings, ILogger logger)

Constructs a client wrapper for the Folders service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient FoldersFoldersClient

The underlying gRPC client.
settings FoldersSettings

The base FoldersSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateFolderOperationsClient

public override OperationsClient CreateFolderOperationsClient { get; }

The long-running operations client for CreateFolder.

Property Value
Type Description
OperationsClient
Overrides

DeleteFolderOperationsClient

public override OperationsClient DeleteFolderOperationsClient { get; }

The long-running operations client for DeleteFolder.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Folders.FoldersClient GrpcClient { get; }

The underlying gRPC Folders client

Property Value
Type Description
FoldersFoldersClient
Overrides

MoveFolderOperationsClient

public override OperationsClient MoveFolderOperationsClient { get; }

The long-running operations client for MoveFolder.

Property Value
Type Description
OperationsClient
Overrides

UndeleteFolderOperationsClient

public override OperationsClient UndeleteFolderOperationsClient { get; }

The long-running operations client for UndeleteFolder.

Property Value
Type Description
OperationsClient
Overrides

UpdateFolderOperationsClient

public override OperationsClient UpdateFolderOperationsClient { get; }

The long-running operations client for UpdateFolder.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateFolder(CreateFolderRequest, CallSettings)

public override Operation<Folder, CreateFolderMetadata> CreateFolder(CreateFolderRequest request, CallSettings callSettings = null)

Creates a folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success, the Operation.response field will be populated with the created Folder.

In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints.

  • The folder's display_name must be distinct from all other folders that share its parent.
  • The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders.
  • The addition of the folder must not cause the total number of folders under its parent to exceed 300.

If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned in the details list in the Operation.error field.

The caller must have resourcemanager.folders.create permission on the identified parent.

Parameters
Name Description
request CreateFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFolderCreateFolderMetadata

The RPC response.
Overrides

CreateFolderAsync(CreateFolderRequest, CallSettings)

public override Task<Operation<Folder, CreateFolderMetadata>> CreateFolderAsync(CreateFolderRequest request, CallSettings callSettings = null)

Creates a folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success, the Operation.response field will be populated with the created Folder.

In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints.

  • The folder's display_name must be distinct from all other folders that share its parent.
  • The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders.
  • The addition of the folder must not cause the total number of folders under its parent to exceed 300.

If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned in the details list in the Operation.error field.

The caller must have resourcemanager.folders.create permission on the identified parent.

Parameters
Name Description
request CreateFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFolderCreateFolderMetadata

A Task containing the RPC response.
Overrides

DeleteFolder(DeleteFolderRequest, CallSettings)

public override Operation<Folder, DeleteFolderMetadata> DeleteFolder(DeleteFolderRequest request, CallSettings callSettings = null)

Requests deletion of a folder. The folder is moved into the [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state. If called on a folder in [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state the operation will result in a no-op success. The caller must have resourcemanager.folders.delete permission on the identified folder.

Parameters
Name Description
request DeleteFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFolderDeleteFolderMetadata

The RPC response.
Overrides

DeleteFolderAsync(DeleteFolderRequest, CallSettings)

public override Task<Operation<Folder, DeleteFolderMetadata>> DeleteFolderAsync(DeleteFolderRequest request, CallSettings callSettings = null)

Requests deletion of a folder. The folder is moved into the [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state. If called on a folder in [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state the operation will result in a no-op success. The caller must have resourcemanager.folders.delete permission on the identified folder.

Parameters
Name Description
request DeleteFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFolderDeleteFolderMetadata

A Task containing the RPC response.
Overrides

GetFolder(GetFolderRequest, CallSettings)

public override Folder GetFolder(GetFolderRequest request, CallSettings callSettings = null)

Retrieves a folder identified by the supplied resource name. Valid folder resource names have the format folders/{folder_id} (for example, folders/1234). The caller must have resourcemanager.folders.get permission on the identified folder.

Parameters
Name Description
request GetFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Folder

The RPC response.
Overrides

GetFolderAsync(GetFolderRequest, CallSettings)

public override Task<Folder> GetFolderAsync(GetFolderRequest request, CallSettings callSettings = null)

Retrieves a folder identified by the supplied resource name. Valid folder resource names have the format folders/{folder_id} (for example, folders/1234). The caller must have resourcemanager.folders.get permission on the identified folder.

Parameters
Name Description
request GetFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFolder

A Task containing the RPC response.
Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The resource field should be the folder's resource name, for example: "folders/1234". The caller must have resourcemanager.folders.getIamPolicy permission on the identified folder.

Parameters
Name Description
request GetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The resource field should be the folder's resource name, for example: "folders/1234". The caller must have resourcemanager.folders.getIamPolicy permission on the identified folder.

Parameters
Name Description
request GetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

ListFolders(ListFoldersRequest, CallSettings)

public override PagedEnumerable<ListFoldersResponse, Folder> ListFolders(ListFoldersRequest request, CallSettings callSettings = null)

Lists the folders that are direct descendants of supplied parent resource. list() provides a strongly consistent view of the folders underneath the specified parent resource. list() returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have resourcemanager.folders.list permission on the identified parent.

Parameters
Name Description
request ListFoldersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFoldersResponseFolder

A pageable sequence of Folder resources.
Overrides

ListFoldersAsync(ListFoldersRequest, CallSettings)

public override PagedAsyncEnumerable<ListFoldersResponse, Folder> ListFoldersAsync(ListFoldersRequest request, CallSettings callSettings = null)

Lists the folders that are direct descendants of supplied parent resource. list() provides a strongly consistent view of the folders underneath the specified parent resource. list() returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have resourcemanager.folders.list permission on the identified parent.

Parameters
Name Description
request ListFoldersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFoldersResponseFolder

A pageable asynchronous sequence of Folder resources.
Overrides

MoveFolder(MoveFolderRequest, CallSettings)

public override Operation<Folder, MoveFolderMetadata> MoveFolder(MoveFolderRequest request, CallSettings callSettings = null)

Moves a folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success, the Operation.response field will be populated with the moved folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned in the Status.details field. If it occurs asynchronously, then the FolderOperation will be returned in the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation. The caller must have resourcemanager.folders.move permission on the folder's current and proposed new parent.

Parameters
Name Description
request MoveFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFolderMoveFolderMetadata

The RPC response.
Overrides

MoveFolderAsync(MoveFolderRequest, CallSettings)

public override Task<Operation<Folder, MoveFolderMetadata>> MoveFolderAsync(MoveFolderRequest request, CallSettings callSettings = null)

Moves a folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success, the Operation.response field will be populated with the moved folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned in the Status.details field. If it occurs asynchronously, then the FolderOperation will be returned in the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation. The caller must have resourcemanager.folders.move permission on the folder's current and proposed new parent.

Parameters
Name Description
request MoveFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFolderMoveFolderMetadata

A Task containing the RPC response.
Overrides

SearchFolders(SearchFoldersRequest, CallSettings)

public override PagedEnumerable<SearchFoldersResponse, Folder> SearchFolders(SearchFoldersRequest request, CallSettings callSettings = null)

Search for folders that match specific filter criteria. search() provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria.

This will only return folders on which the caller has the permission resourcemanager.folders.get.

Parameters
Name Description
request SearchFoldersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchFoldersResponseFolder

A pageable sequence of Folder resources.
Overrides

SearchFoldersAsync(SearchFoldersRequest, CallSettings)

public override PagedAsyncEnumerable<SearchFoldersResponse, Folder> SearchFoldersAsync(SearchFoldersRequest request, CallSettings callSettings = null)

Search for folders that match specific filter criteria. search() provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria.

This will only return folders on which the caller has the permission resourcemanager.folders.get.

Parameters
Name Description
request SearchFoldersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchFoldersResponseFolder

A pageable asynchronous sequence of Folder resources.
Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on a folder, replacing any existing policy. The resource field should be the folder's resource name, for example: "folders/1234". The caller must have resourcemanager.folders.setIamPolicy permission on the identified folder.

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on a folder, replacing any existing policy. The resource field should be the folder's resource name, for example: "folders/1234". The caller must have resourcemanager.folders.setIamPolicy permission on the identified folder.

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified folder. The resource field should be the folder's resource name, for example: "folders/1234".

There are no permissions required for making this API call.

Parameters
Name Description
request TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TestIamPermissionsResponse

The RPC response.
Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified folder. The resource field should be the folder's resource name, for example: "folders/1234".

There are no permissions required for making this API call.

Parameters
Name Description
request TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestIamPermissionsResponse

A Task containing the RPC response.
Overrides

UndeleteFolder(UndeleteFolderRequest, CallSettings)

public override Operation<Folder, UndeleteFolderMetadata> UndeleteFolder(UndeleteFolderRequest request, CallSettings callSettings = null)

Cancels the deletion request for a folder. This method may be called on a folder in any state. If the folder is in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state the result will be a no-op success. In order to succeed, the folder's parent must be in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation. The caller must have resourcemanager.folders.undelete permission on the identified folder.

Parameters
Name Description
request UndeleteFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFolderUndeleteFolderMetadata

The RPC response.
Overrides

UndeleteFolderAsync(UndeleteFolderRequest, CallSettings)

public override Task<Operation<Folder, UndeleteFolderMetadata>> UndeleteFolderAsync(UndeleteFolderRequest request, CallSettings callSettings = null)

Cancels the deletion request for a folder. This method may be called on a folder in any state. If the folder is in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state the result will be a no-op success. In order to succeed, the folder's parent must be in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation. The caller must have resourcemanager.folders.undelete permission on the identified folder.

Parameters
Name Description
request UndeleteFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFolderUndeleteFolderMetadata

A Task containing the RPC response.
Overrides

UpdateFolder(UpdateFolderRequest, CallSettings)

public override Operation<Folder, UpdateFolderMetadata> UpdateFolder(UpdateFolderRequest request, CallSettings callSettings = null)

Updates a folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or the naming constraints described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation.

The folder's display_name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: [\p{L}\p{N}][\p{L}\p{N}_- ]{1,28}[\p{L}\p{N}]. The caller must have resourcemanager.folders.update permission on the identified folder.

If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.

Parameters
Name Description
request UpdateFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFolderUpdateFolderMetadata

The RPC response.
Overrides

UpdateFolderAsync(UpdateFolderRequest, CallSettings)

public override Task<Operation<Folder, UpdateFolderMetadata>> UpdateFolderAsync(UpdateFolderRequest request, CallSettings callSettings = null)

Updates a folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or the naming constraints described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation.

The folder's display_name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: [\p{L}\p{N}][\p{L}\p{N}_- ]{1,28}[\p{L}\p{N}]. The caller must have resourcemanager.folders.update permission on the identified folder.

If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.

Parameters
Name Description
request UpdateFolderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFolderUpdateFolderMetadata

A Task containing the RPC response.
Overrides