Struct google_books1::VolumeListCall [−][src]
pub struct VolumeListCall<'a, C, A> where
C: 'a,
A: 'a, { /* fields omitted */ }
Performs a book search.
A builder for the list method supported by a volume resource.
It is not used directly, but through a VolumeMethods
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.volumes().list("q") .start_index(63) .source("sea") .show_preorders(false) .projection("ipsum") .print_type("aliquyam") .partner("dolores") .order_by("sit") .max_results(60) .max_allowed_maturity_rating("ut") .library_restrict("justo") .lang_restrict("est") .filter("amet") .download("accusam") .doit();
Methods
impl<'a, C, A> VolumeListCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
impl<'a, C, A> VolumeListCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, Volumes)>
[src]
pub fn doit(self) -> Result<(Response, Volumes)>
Perform the operation you have build so far.
pub fn q(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn q(self, new_value: &str) -> VolumeListCall<'a, C, A>
Full-text search query string.
Sets the q query 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_index(self, new_value: u32) -> VolumeListCall<'a, C, A>
[src]
pub fn start_index(self, new_value: u32) -> VolumeListCall<'a, C, A>
Index of the first result to return (starts at 0)
Sets the start index query property to the given value.
pub fn source(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn source(self, new_value: &str) -> VolumeListCall<'a, C, A>
String to identify the originator of this request.
Sets the source query property to the given value.
pub fn show_preorders(self, new_value: bool) -> VolumeListCall<'a, C, A>
[src]
pub fn show_preorders(self, new_value: bool) -> VolumeListCall<'a, C, A>
Set to true to show books available for preorder. Defaults to false.
Sets the show preorders query property to the given value.
pub fn projection(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn projection(self, new_value: &str) -> VolumeListCall<'a, C, A>
Restrict information returned to a set of selected fields.
Sets the projection query property to the given value.
pub fn print_type(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn print_type(self, new_value: &str) -> VolumeListCall<'a, C, A>
Restrict to books or magazines.
Sets the print type query property to the given value.
pub fn partner(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn partner(self, new_value: &str) -> VolumeListCall<'a, C, A>
Restrict and brand results for partner ID.
Sets the partner query property to the given value.
pub fn order_by(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn order_by(self, new_value: &str) -> VolumeListCall<'a, C, A>
Sort search results.
Sets the order by query property to the given value.
pub fn max_results(self, new_value: u32) -> VolumeListCall<'a, C, A>
[src]
pub fn max_results(self, new_value: u32) -> VolumeListCall<'a, C, A>
Maximum number of results to return.
Sets the max results query property to the given value.
pub fn max_allowed_maturity_rating(
self,
new_value: &str
) -> VolumeListCall<'a, C, A>
[src]
pub fn max_allowed_maturity_rating(
self,
new_value: &str
) -> VolumeListCall<'a, C, A>
The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
Sets the max allowed maturity rating query property to the given value.
pub fn library_restrict(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn library_restrict(self, new_value: &str) -> VolumeListCall<'a, C, A>
Restrict search to this user's library.
Sets the library restrict query property to the given value.
pub fn lang_restrict(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn lang_restrict(self, new_value: &str) -> VolumeListCall<'a, C, A>
Restrict results to books with this language code.
Sets the lang restrict query property to the given value.
pub fn filter(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn filter(self, new_value: &str) -> VolumeListCall<'a, C, A>
Filter search results.
Sets the filter query property to the given value.
pub fn download(self, new_value: &str) -> VolumeListCall<'a, C, A>
[src]
pub fn download(self, new_value: &str) -> VolumeListCall<'a, C, A>
Restrict to volumes by download availability.
Sets the download query property to the given value.
pub fn delegate(self, new_value: &'a mut Delegate) -> VolumeListCall<'a, C, A>
[src]
pub fn delegate(self, new_value: &'a mut Delegate) -> VolumeListCall<'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) -> VolumeListCall<'a, C, A> where
T: AsRef<str>,
[src]
pub fn param<T>(self, name: T, value: T) -> VolumeListCall<'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
- 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) -> VolumeListCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
pub fn add_scope<T, S>(self, scope: T) -> VolumeListCall<'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 VolumeListCall<'a, C, A>
[src]
impl<'a, C, A> CallBuilder for VolumeListCall<'a, C, A>
Auto Trait Implementations
impl<'a, C, A> !Send for VolumeListCall<'a, C, A>
impl<'a, C, A> !Send for VolumeListCall<'a, C, A>
impl<'a, C, A> !Sync for VolumeListCall<'a, C, A>
impl<'a, C, A> !Sync for VolumeListCall<'a, C, A>