Struct google_playmoviespartner1::AccountAvailListCall

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

List Avails owned or managed by the partner.

See Authentication and Authorization rules and List methods rules for more information about this method.

A builder for the avails.list method supported by a account resource. It is not used directly, but through a AccountMethods 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.accounts().avails_list("accountId")
             .add_video_ids("et")
             .title("et")
             .add_territories("diam")
             .add_studio_names("ipsum")
             .add_pph_names("Lorem")
             .page_token("et")
             .page_size(-70)
             .add_alt_ids("aliquyam")
             .alt_id("sea")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

REQUIRED. See General rules for more information about this field.

Sets the account 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_video_ids(self, new_value: &str) -> AccountAvailListCall<'a, C, A>

Filter Avails that match any of the given video_ids.

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

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

Filter that matches Avails with a title_internal_alias, series_title_internal_alias, season_title_internal_alias, or episode_title_internal_alias that contains the given case-insensitive title.

Sets the title query property to the given value.

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

Filter Avails that match (case-insensitive) any of the given country codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us").

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

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

See List methods rules for info about this field.

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

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

See List methods rules for info about this field.

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

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

See List methods rules for info about this field.

Sets the page token query property to the given value.

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

See List methods rules for info about this field.

Sets the page size query property to the given value.

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

Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.

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

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

Filter Avails that match a case-insensitive, partner-specific custom id. NOTE: this field is deprecated and will be removed on V2; alt_ids should be used instead.

Sets the alt id query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> AccountAvailListCall<'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) -> AccountAvailListCall<'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").
• pp (query-boolean) - Pretty-print response.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• bearer_token (query-string) - OAuth bearer token.
• 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) -> AccountAvailListCall<'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::PlaymovyPartnerReadonly.

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