Struct google_orgpolicy2::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 OrgPolicyAPI
hub.
§Example
Instantiate a resource builder
extern crate hyper;
extern crate hyper_rustls;
extern crate google_orgpolicy2 as orgpolicy2;
use std::default::Default;
use orgpolicy2::{OrgPolicyAPI, 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 = OrgPolicyAPI::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 `constraints_list(...)`, `policies_create(...)`, `policies_delete(...)`, `policies_get(...)`, `policies_get_effective_policy(...)`, `policies_list(...)` and `policies_patch(...)`
// 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 constraints_list(&self, parent: &str) -> FolderConstraintListCall<'a, S>
pub fn constraints_list(&self, parent: &str) -> FolderConstraintListCall<'a, S>
Create a builder to help you perform the following task:
Lists constraints that could be applied on the specified resource.
§Arguments
parent
- Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: *projects/{project_number}
*projects/{project_id}
*folders/{folder_id}
*organizations/{organization_id}
sourcepub fn policies_create(
&self,
request: GoogleCloudOrgpolicyV2Policy,
parent: &str
) -> FolderPolicyCreateCall<'a, S>
pub fn policies_create( &self, request: GoogleCloudOrgpolicyV2Policy, parent: &str ) -> FolderPolicyCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a policy. Returns a google.rpc.Status
with google.rpc.Code.NOT_FOUND
if the constraint does not exist. Returns a google.rpc.Status
with google.rpc.Code.ALREADY_EXISTS
if the policy already exists on the given Google Cloud resource.
§Arguments
request
- No description provided.parent
- Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: *projects/{project_number}
*projects/{project_id}
*folders/{folder_id}
*organizations/{organization_id}
sourcepub fn policies_delete(&self, name: &str) -> FolderPolicyDeleteCall<'a, S>
pub fn policies_delete(&self, name: &str) -> FolderPolicyDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a policy. Returns a google.rpc.Status
with google.rpc.Code.NOT_FOUND
if the constraint or organization policy does not exist.
§Arguments
name
- Required. Name of the policy to delete. See the policy entry for naming rules.
sourcepub fn policies_get(&self, name: &str) -> FolderPolicyGetCall<'a, S>
pub fn policies_get(&self, name: &str) -> FolderPolicyGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND
is returned. The etag
value can be used with UpdatePolicy()
to update a policy during read-modify-write.
§Arguments
name
- Required. Resource name of the policy. See Policy for naming requirements.
sourcepub fn policies_get_effective_policy(
&self,
name: &str
) -> FolderPolicyGetEffectivePolicyCall<'a, S>
pub fn policies_get_effective_policy( &self, name: &str ) -> FolderPolicyGetEffectivePolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag
or condition
set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with ‘under:’ prefix will not be expanded.
§Arguments
name
- Required. The effective policy to compute. See Policy for naming requirements.
sourcepub fn policies_list(&self, parent: &str) -> FolderPolicyListCall<'a, S>
pub fn policies_list(&self, parent: &str) -> FolderPolicyListCall<'a, S>
Create a builder to help you perform the following task:
Retrieves all of the policies that exist on a particular resource.
§Arguments
parent
- Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: *projects/{project_number}
*projects/{project_id}
*folders/{folder_id}
*organizations/{organization_id}
sourcepub fn policies_patch(
&self,
request: GoogleCloudOrgpolicyV2Policy,
name: &str
) -> FolderPolicyPatchCall<'a, S>
pub fn policies_patch( &self, request: GoogleCloudOrgpolicyV2Policy, name: &str ) -> FolderPolicyPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates a policy. Returns a google.rpc.Status
with google.rpc.Code.NOT_FOUND
if the constraint or the policy do not exist. Returns a google.rpc.Status
with google.rpc.Code.ABORTED
if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.
§Arguments
request
- No description provided.name
- Immutable. The resource name of the policy. Must be one of the following forms, whereconstraint_name
is the name of the constraint which this policy configures: *projects/{project_number}/policies/{constraint_name}
*folders/{folder_id}/policies/{constraint_name}
*organizations/{organization_id}/policies/{constraint_name}
For example,projects/123/policies/compute.disableSerialPortAccess
. Note:projects/{project_id}/policies/{constraint_name}
is also an acceptable name for API requests, but responses will return the name using the equivalent project number.