Struct MethodSearchAllIamPolicyCall

Source

pub struct MethodSearchAllIamPolicyCall<'a, C>where
    C: 'a,
{ /* private fields */ }

Expand description

Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope, otherwise the request will be rejected.

A builder for the searchAllIamPolicies method. It is not used directly, but through a MethodMethods instance.

§Example

Instantiate a resource method builder




// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.methods().search_all_iam_policies("scope")
             .query("Stet")
             .page_token("vero")
             .page_size(-44)
             .order_by("Lorem")
             .add_asset_types("diam")
             .doit().await;

Implementations§

Source §

impl<'a, C> MethodSearchAllIamPolicyCall<'a, C>
where C: Connector,

Source

pub async fn doit(self) -> Result<(Response, SearchAllIamPoliciesResponse)>

Perform the operation you have build so far.

Source

pub fn scope(self, new_value: &str) -> MethodSearchAllIamPolicyCall<'a, C>

Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the scope. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope. The allowed values are: * projects/{PROJECT_ID} (e.g., “projects/foo-bar”) * projects/{PROJECT_NUMBER} (e.g., “projects/12345678”) * folders/{FOLDER_NUMBER} (e.g., “folders/1234567”) * organizations/{ORGANIZATION_NUMBER} (e.g., “organizations/123456”)

Sets the scope path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

Source

pub fn query(self, new_value: &str) -> MethodSearchAllIamPolicyCall<'a, C>

Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified scope. Note that the query string is compared against each IAM policy binding, including its principals, roles, and IAM conditions. The returned IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation. Examples: * policy:amy@gmail.com to find IAM policy bindings that specify user “amy@gmail.com”. * policy:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role. * policy:comp* to find IAM policy bindings that contain “comp” as a prefix of any word in the binding. * policy.role.permissions:storage.buckets.update to find IAM policy bindings that specify a role containing “storage.buckets.update” permission. Note that if callers don’t have iam.roles.get access to a role’s included permissions, policy bindings that specify this role will be dropped from the search results. * policy.role.permissions:upd* to find IAM policy bindings that specify a role containing “upd” as a prefix of any word in the role permission. Note that if callers don’t have iam.roles.get access to a role’s included permissions, policy bindings that specify this role will be dropped from the search results. * resource:organizations/123456 to find IAM policy bindings that are set on “organizations/123456”. * resource=//cloudresourcemanager.googleapis.com/projects/myproject to find IAM policy bindings that are set on the project named “myproject”. * Important to find IAM policy bindings that contain “Important” as a word in any of the searchable fields (except for the included permissions). * resource:(instance1 OR instance2) policy:amy to find IAM policy bindings that are set on resources “instance1” or “instance2” and also specify user “amy”. * roles:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role. * memberTypes:user to find IAM policy bindings that contain the principal type “user”.

Sets the query query property to the given value.

Source

pub fn page_token(self, new_value: &str) -> MethodSearchAllIamPolicyCall<'a, C>

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

Sets the page token query property to the given value.

Source

pub fn page_size(self, new_value: i32) -> MethodSearchAllIamPolicyCall<'a, C>

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero or a negative value, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

Sets the page size query property to the given value.

Source

pub fn order_by(self, new_value: &str) -> MethodSearchAllIamPolicyCall<'a, C>

Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add “ DESC“ after the field name to indicate descending order. Redundant space characters are ignored. Example: “assetType DESC, resource”. Only singular primitive fields in the response are sortable: * resource * assetType * project All the other fields such as repeated fields (e.g., folders) and non-primitive fields (e.g., policy) are not supported.

Sets the order by query property to the given value.

Source

pub fn add_asset_types( self, new_value: &str, ) -> MethodSearchAllIamPolicyCall<'a, C>

Optional. A list of asset types that the IAM policies are attached to. If empty, it will search the IAM policies that are attached to all the asset types supported by search APIs Regular expressions are also supported. For example: * “compute.googleapis.com.*” snapshots IAM policies attached to asset type starts with “compute.googleapis.com”. * “.*Instance” snapshots IAM policies attached to asset type ends with “Instance”. * “.Instance.” snapshots IAM policies attached to asset type contains “Instance”. See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

Append the given value to the asset types query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.

Source

pub fn delegate( self, new_value: &'a mut dyn Delegate, ) -> MethodSearchAllIamPolicyCall<'a, C>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

                  It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

Source

pub fn param<T>(self, name: T, value: T) -> MethodSearchAllIamPolicyCall<'a, C>
where T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

§Additional Parameters

$.xgafv (query-string) - V1 error format.
access_token (query-string) - OAuth access token.
alt (query-string) - Data format for response.
callback (query-string) - JSONP
fields (query-string) - Selector specifying which fields to include in a partial response.
key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_token (query-string) - OAuth 2.0 token for the current user.
prettyPrint (query-boolean) - Returns response with indentations and line breaks.
quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

Source

pub fn add_scope<St>(self, scope: St) -> MethodSearchAllIamPolicyCall<'a, C>
where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Source

pub fn add_scopes<I, St>(self, scopes: I) -> MethodSearchAllIamPolicyCall<'a, C>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

Source

pub fn clear_scopes(self) -> MethodSearchAllIamPolicyCall<'a, C>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).