Struct google_admin1_reports::UserUsageReportGetCall

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

Retrieves a report which is a collection of properties / statistics for a set of users.

A builder for the get method supported by a userUsageReport resource. It is not used directly, but through a UserUsageReportMethods 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.user_usage_report().get("userKey", "date")
             .parameters("et")
             .page_token("consetetur")
             .max_results(65)
             .filters("ea")
             .customer_id("sed")
             .doit();

Methods

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

fn doit(self) -> Result<(Response, UsageReports)>

Perform the operation you have build so far.

fn user_key(self, new_value: &str) -> UserUsageReportGetCall<'a, C, A>

Represents the profile id or the user email for which the data should be filtered.

Sets the user key 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.

fn date(self, new_value: &str) -> UserUsageReportGetCall<'a, C, A>

Represents the date in yyyy-mm-dd format for which the data is to be fetched.

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

fn parameters(self, new_value: &str) -> UserUsageReportGetCall<'a, C, A>

Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.

Sets the parameters query property to the given value.

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

Token to specify next page.

Sets the page token query property to the given value.

fn max_results(self, new_value: u32) -> UserUsageReportGetCall<'a, C, A>

Maximum number of results to return. Maximum allowed is 1000

Sets the max results query property to the given value.

fn filters(self, new_value: &str) -> UserUsageReportGetCall<'a, C, A>

Represents the set of filters including parameter operator value.

Sets the filters query property to the given value.

fn customer_id(self, new_value: &str) -> UserUsageReportGetCall<'a, C, A>

Represents the customer for which the data is to be fetched.

Sets the customer id query property to the given value.

fn delegate(
    self,
    new_value: &'a mut Delegate
) -> UserUsageReportGetCall<'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.

fn param<T>(self, name: T, value: T) -> UserUsageReportGetCall<'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 paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• 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. Overrides userIp if both are provided.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

fn add_scope<T>(self, scope: T) -> UserUsageReportGetCall<'a, C, A> where
    T: 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::ReportUsageReadonly.

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.

Trait Implementations

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