Struct google_youtubereporting1::JobReportListCall

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

Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.

A builder for the reports.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().reports_list("jobId")
             .start_time_before("erat")
             .start_time_at_or_after("sadipscing")
             .page_token("dolor")
             .page_size(-39)
             .on_behalf_of_content_owner("elitr")
             .created_after("amet")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The ID of the job.

Sets the job 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 start_time_before(self, new_value: &str) -> JobReportListCall<'a, C, A>

If set, only reports whose start time is smaller than the specified date/time are returned.

Sets the start time before query property to the given value.

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

If set, only reports whose start time is greater than or equal the specified date/time are returned.

Sets the start time at or after query property to the given value.

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

A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the ListReports method.

Sets the page token query property to the given value.

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

Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.

Sets the page size query property to the given value.

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

The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

Sets the on behalf of content owner query property to the given value.

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

If set, only reports created after the specified date/time are returned.

Sets the created after query property to the given value.

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

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