Struct google_monitoring3::ProjectGroupListCall

pub struct ProjectGroupListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Lists the existing groups.

A builder for the groups.list method supported by a project resource. It is not used directly, but through a ProjectMethods 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.projects().groups_list("name")
             .page_token("dolores")
             .page_size(-61)
             .descendants_of_group("sadipscing")
             .children_of_group("aliquyam")
             .ancestors_of_group("ea")
             .doit();

Methods

impl<'a, C, A> ProjectGroupListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

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

Perform the operation you have build so far.

pub fn name(self, new_value: &str) -> ProjectGroupListCall<'a, C, A>

The project whose groups are to be listed. The format is "projects/{project_id_or_number}".

Sets the name 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.

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

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Sets the page token query property to the given value.

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

A positive number that is the maximum number of results to return.

Sets the page size query property to the given value.

pub fn descendants_of_group(
    self,
    new_value: &str
) -> ProjectGroupListCall<'a, C, A>

A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.

Sets the descendants of group query property to the given value.

pub fn children_of_group(
    self,
    new_value: &str
) -> ProjectGroupListCall<'a, C, A>

A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.

Sets the children of group query property to the given value.

pub fn ancestors_of_group(
    self,
    new_value: &str
) -> ProjectGroupListCall<'a, C, A>

A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

Sets the ancestors of group query property to the given value.

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

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.

pub fn param<T>(self, name: T, value: T) -> ProjectGroupListCall<'a, C, A> 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

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• 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.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• 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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> ProjectGroupListCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead 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. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

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.

Trait Implementations

impl<'a, C, A> CallBuilder for ProjectGroupListCall<'a, C, A>