Struct google_monitoring3::api::ProjectGroupListCall

source ·

pub struct ProjectGroupListCall<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

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("vero")
             .page_size(-88)
             .descendants_of_group("Stet")
             .children_of_group("vero")
             .ancestors_of_group("elitr")
             .doit().await;

Implementations§

source §

impl<'a, S> ProjectGroupListCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

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

Perform the operation you have build so far.

source

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

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) 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.

source

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

If this field is not empty then it must contain the next_page_token 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.

source

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

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

Sets the page size query property to the given value.

source

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

A group name. The format is: 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 children_of_group filter, and includes children-of-children, and so forth.

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

source

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

A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose parent_name 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.

source

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

A group name. The format is: 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.

source

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

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) -> ProjectGroupListCall<'a, S>
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) -> ProjectGroupListCall<'a, S>
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) -> ProjectGroupListCall<'a, S>
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) -> ProjectGroupListCall<'a, S>

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).