Struct google_alertcenter1_beta1::AlertListCall

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

Lists all the alerts for the current user and application.

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("et")
             .page_size(-17)
             .order_by("diam")
             .filter("ipsum")
             .customer_id("Lorem")
             .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. Requested page size. Server may return fewer items than requested. If unspecified, server will pick 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. Sort the list results by a certain order. If not specified results may be returned in arbitrary order. You can sort the results in a descending order based on the creation timestamp using order_by="create_time desc". Currently, only sorting by create_time desc is supported.

Sets the order by query property to the given value.

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

Optional. Query string for filtering alert results. This string must be specified as an expression or list of expressions, using the following grammar:

Expressions

An expression has the general form <field> <operator> <value>.

A field or value which contains a space or a colon must be enclosed by double quotes.

Operators

Operators follow the BNF specification:

<equalityOperator> ::= "=" | ":"

<relationalOperator> ::= "<" | ">" | "<=" | ">="

Relational operators are defined only for timestamp fields. Equality operators are defined only for string fields.

Timestamp fields

The value supplied for a timestamp field must be an RFC 3339 date-time string.

Supported timestamp fields are create_time, start_time, and end_time.

String fields

The value supplied for a string field may be an arbitrary string.

Examples

To query for all alerts created on or after April 5, 2018:

create_time >= "2018-04-05T00:00:00Z"

To query for all alerts from the source "Gmail phishing":

source:"Gmail phishing"

Joining expressions

Expressions may be joined to form a more complex query. The BNF specification is:

<expressionList> ::= <expression> | <expressionList> <conjunction> <expressionList> | <negation> <expressionList> <conjunction> ::= "AND" | "OR" | "" <negation> ::= "NOT"

Using the empty string as a conjunction acts as an implicit AND.

The precedence of joining operations, from highest to lowest, is NOT, AND, OR.

Examples

To query for all alerts which started in 2017:

start_time >= "2017-01-01T00:00:00Z" AND start_time < "2018-01-01T00:00:00Z"

To query for all user reported phishing alerts from the source "Gmail phishing":

type:"User reported phishing" source:"Gmail phishing"

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 Google account of the customer the alerts are associated with. This is obfuscated and not the plain customer ID as stored internally. 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 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 paramters 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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• 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.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

Trait Implementations

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