Struct google_cloudresourcemanager3::api::FolderMethods
source · pub struct FolderMethods<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
A builder providing access to all methods supported on folder resources.
It is not used directly, but through the CloudResourceManager
hub.
§Example
Instantiate a resource builder
extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudresourcemanager3 as cloudresourcemanager3;
use std::default::Default;
use cloudresourcemanager3::{CloudResourceManager, oauth2, hyper, hyper_rustls, chrono, FieldMask};
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = CloudResourceManager::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `create(...)`, `delete(...)`, `get(...)`, `get_iam_policy(...)`, `list(...)`, `move_(...)`, `patch(...)`, `search(...)`, `set_iam_policy(...)`, `test_iam_permissions(...)` and `undelete(...)`
// to build up your call.
let rb = hub.folders();
Implementations§
source§impl<'a, S> FolderMethods<'a, S>
impl<'a, S> FolderMethods<'a, S>
sourcepub fn create(&self, request: Folder) -> FolderCreateCall<'a, S>
pub fn create(&self, request: Folder) -> FolderCreateCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.
sourcepub fn delete(&self, name: &str) -> FolderDeleteCall<'a, S>
pub fn delete(&self, name: &str) -> FolderDeleteCall<'a, S>
Create a builder to help you perform the following task:
Requests deletion of a folder. The folder is moved into the 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 state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-op success. The caller must have resourcemanager.folders.delete
permission on the identified folder.
§Arguments
name
- Required. The resource name of the folder to be deleted. Must be of the formfolders/{folder_id}
.
sourcepub fn get(&self, name: &str) -> FolderGetCall<'a, S>
pub fn get(&self, name: &str) -> FolderGetCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
name
- Required. The resource name of the folder to retrieve. Must be of the formfolders/{folder_id}
.
sourcepub fn get_iam_policy(
&self,
request: GetIamPolicyRequest,
resource: &str
) -> FolderGetIamPolicyCall<'a, S>
pub fn get_iam_policy( &self, request: GetIamPolicyRequest, resource: &str ) -> FolderGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn list(&self) -> FolderListCall<'a, S>
pub fn list(&self) -> FolderListCall<'a, S>
Create a builder to help you perform the following task:
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.
sourcepub fn move_(
&self,
request: MoveFolderRequest,
name: &str
) -> FolderMoveCall<'a, S>
pub fn move_( &self, request: MoveFolderRequest, name: &str ) -> FolderMoveCall<'a, S>
Create a builder to help you perform the following task:
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 documentation. The caller must have resourcemanager.folders.move
permission on the folder’s current and proposed new parent.
§Arguments
request
- No description provided.name
- Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}
sourcepub fn patch(&self, request: Folder, name: &str) -> FolderPatchCall<'a, S>
pub fn patch(&self, request: Folder, name: &str) -> FolderPatchCall<'a, S>
Create a builder to help you perform the following task:
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 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}{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.
§Arguments
request
- No description provided.name
- Output only. The resource name of the folder. Its format isfolders/{folder_id}
, for example: “folders/1234”.
sourcepub fn search(&self) -> FolderSearchCall<'a, S>
pub fn search(&self) -> FolderSearchCall<'a, S>
Create a builder to help you perform the following task:
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
.
sourcepub fn set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> FolderSetIamPolicyCall<'a, S>
pub fn set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> FolderSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> FolderTestIamPermissionCall<'a, S>
pub fn test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> FolderTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn undelete(
&self,
request: UndeleteFolderRequest,
name: &str
) -> FolderUndeleteCall<'a, S>
pub fn undelete( &self, request: UndeleteFolderRequest, name: &str ) -> FolderUndeleteCall<'a, S>
Create a builder to help you perform the following task:
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 state the result will be a no-op success. In order to succeed, the folder’s parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described in the CreateFolder documentation. The caller must have resourcemanager.folders.undelete
permission on the identified folder.
§Arguments
request
- No description provided.name
- Required. The resource name of the folder to undelete. Must be of the formfolders/{folder_id}
.