Struct google_alertcenter1_beta1::AlertListCall

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

Lists the alerts.

A builder for the list method supported by a alert resource. It is not used directly, but through a AlertMethods 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.alerts().list()
             .page_token("no")
             .page_size(-21)
             .order_by("justo")
             .filter("et")
             .customer_id("et")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.

Sets the page token query property to the given value.

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

Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.

Sets the page size query property to the given value.

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

Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using order_by="create_time desc". Currently, supported sorting are create_time asc, create_time desc, update_time desc

Sets the order by query property to the given value.

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

Optional. A query string for filtering alert results. For more details, see Query filters and Supported query filter fields.

Sets the filter query property to the given value.

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

Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.

Sets the customer id query property to the given value.

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

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 AlertListCall<'a, C, A>