Struct google_books1::OnboardingListCategoryVolumeCall

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

List available volumes under categories for onboarding experience.

A builder for the listCategoryVolumes method supported by a onboarding resource. It is not used directly, but through a OnboardingMethods 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.onboarding().list_category_volumes()
             .page_token("ut")
             .page_size(98)
             .max_allowed_maturity_rating("sea")
             .locale("ut")
             .add_category_id("eirmod")
             .doit();

Implementations

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

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

Perform the operation you have build so far.

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

The value of the nextToken from the previous page.

Sets the page token query property to the given value.

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

Number of maximum results per page to be included in the response.

Sets the page size query property to the given value.

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

The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.

Sets the max allowed maturity rating query property to the given value.

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

ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.

Sets the locale query property to the given value.

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

List of category ids requested.

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

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