Struct google_bigquery2::JobListCall

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

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

A builder for the list method supported by a job resource. It is not used directly, but through a JobMethods 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.jobs().list("projectId")
             .add_state_filter("eirmod")
             .projection("sanctus")
             .page_token("et")
             .min_creation_time("amet")
             .max_results(78)
             .max_creation_time("consetetur")
             .all_users(true)
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

Project ID of the jobs to list

Sets the project id 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 add_state_filter(self, new_value: &str) -> JobListCall<'a, C, A>

Filter for job state

Append the given value to the state filter query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

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

Restrict information returned to a set of selected fields

Sets the projection query property to the given value.

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

Page token, returned by a previous call, to request the next page of results

Sets the page token query property to the given value.

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

Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned

Sets the min creation time query property to the given value.

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

Maximum number of results to return

Sets the max results query property to the given value.

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

Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned

Sets the max creation time query property to the given value.

pub fn all_users(self, new_value: bool) -> JobListCall<'a, C, A>

Whether to display jobs owned by all users in the project. Default false

Sets the all users query property to the given value.

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

• quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• 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) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> JobListCall<'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::Full.

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