package google.cloud.resourcemanager.v2
Get desktop application:
View/edit binary Protocol Buffers messages
service Folders
folders.proto:40Manages Cloud Resource Folders. Cloud Resource Folders can be used to organize the resources under an organization and to control the IAM policies applied to groups of resources.
rpc ListFolders (, )
folders.proto:53Lists 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.
message
folders.proto:304The ListFolders request message.
string parent = 1
Required. The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.
int32 page_size = 2
Optional. The maximum number of Folders to return in the response.
string page_token = 3
Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.
bool show_deleted = 4
Optional. Controls whether Folders in the [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state should be returned. Defaults to false.
message
folders.proto:331The ListFolders response message.
repeated folders = 1
A possibly paginated list of Folders that are direct descendants of the specified parent resource.
string next_page_token = 2
A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue.
rpc SearchFolders (, )
folders.proto:66Search 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`.
message
folders.proto:342The request message for searching folders.
int32 page_size = 1
Optional. The maximum number of folders to return in the response.
string page_token = 2
Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue.
string query = 3
Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with "Test". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder resources with display names that include both "Test" and "String".
message
folders.proto:377The response message for searching folders.
repeated folders = 1
A possibly paginated folder search results. the specified parent resource.
string next_page_token = 2
A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue.
rpc GetFolder (, )
folders.proto:79Retrieves 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.
message
folders.proto:388The GetFolder request message.
string name = 1
Required. The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`.
rpc CreateFolder (, )
folders.proto:113Creates 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 Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; 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 100. 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 via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent.
message
folders.proto:400The CreateFolder request message.
string parent = 1
Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
optional folder = 2
Required. The Folder being created, only the display name will be consulted. All other fields will be ignored.
rpc UpdateFolder (, )
folders.proto:140Updates 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 naming constraints described in the [CreateFolder][google.cloud.resourcemanager.v2.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 no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,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.
message
folders.proto:438The request message for updating a folder's display name.
optional folder = 1
Required. The new definition of the Folder. It must include a a `name` and `display_name` field. The other fields will be ignored.
optional update_mask = 2
Required. Fields to be updated. Only the `display_name` can be updated.
rpc MoveFolder (, )
folders.proto:165Moves 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 via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via 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.v2.Folders.CreateFolder] documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent.
message
folders.proto:416The MoveFolder request message.
string name = 1
Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}
string destination_parent = 2
Required. The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
rpc DeleteFolder (, )
folders.proto:186Requests deletion of a Folder. The Folder is moved into the [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state immediately, and is deleted approximately 30 days later. This method may only be called on an empty Folder in the [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state, where a Folder is empty if it doesn't contain any Folders or Projects in the [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state. The caller must have `resourcemanager.folders.delete` permission on the identified folder.
message
folders.proto:450The DeleteFolder request message.
string name = 1
Required. The resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`.
bool recursive_delete = 2
Instructs DeleteFolderAction to delete a folder even when the folder is not empty.
rpc UndeleteFolder (, )
folders.proto:204Cancels the deletion request for a Folder. This method may only be called on a Folder in the [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state. In order to succeed, the Folder's parent must be in the [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.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.v2.Folders.CreateFolder] documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder.
message
folders.proto:466The UndeleteFolder request message.
string name = 1
Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`.
rpc GetIamPolicy (, )
folders.proto:217Gets 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, e.g. "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder.
rpc SetIamPolicy (, )
folders.proto:230Sets the access control policy on a Folder, replacing any existing policy. The `resource` field should be the Folder's resource name, e.g. "folders/1234". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder.
rpc TestIamPermissions (, )
folders.proto:243Returns permissions that a caller has on the specified Folder. The `resource` field should be the Folder's resource name, e.g. "folders/1234". There are no permissions required for making this API call.
message
folders.proto:254A Folder in an Organization's resource hierarchy, used to organize that Organization's resources.
Used as response type in: Folders.DeleteFolder, Folders.GetFolder, Folders.UndeleteFolder, Folders.UpdateFolder
Used as field type in: , , ,
string name = 1
Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234".
string parent = 2
Required. The Folder’s parent's resource name. Updates to the folder's parent must be performed via [MoveFolder][google.cloud.resourcemanager.v2.Folders.MoveFolder].
string display_name = 3
The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Folder.LifecycleState lifecycle_state = 4
Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via [DeleteFolder][google.cloud.resourcemanager.v2.Folders.DeleteFolder] and [UndeleteFolder][google.cloud.resourcemanager.v2.Folders.UndeleteFolder].
optional create_time = 5
Output only. Timestamp when the Folder was created. Assigned by the server.
optional update_time = 6
Output only. Timestamp when the Folder was last modified.
Folder lifecycle states.
Used in:
LIFECYCLE_STATE_UNSPECIFIED = 0
Unspecified state.
ACTIVE = 1
The normal and active state.
DELETE_REQUESTED = 2
The folder has been marked for deletion by the user.
message
folders.proto:478Metadata describing a long running folder operation
string display_name = 1
The display name of the folder.
FolderOperation.OperationType operation_type = 2
The type of this operation.
string source_parent = 3
The resource name of the folder's parent. Only applicable when the operation_type is MOVE.
string destination_parent = 4
The resource name of the folder or organization we are either creating the folder under or moving the folder to.
The type of operation that failed.
Used in:
OPERATION_TYPE_UNSPECIFIED = 0
Operation type not specified.
CREATE = 1
A create folder operation.
MOVE = 2
A move folder operation.