Struct google_books1::MylibraryAnnotationListCall

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

Retrieves a list of annotations, possibly filtered.

A builder for the annotations.list method supported by a mylibrary resource. It is not used directly, but through a MylibraryMethods 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.mylibrary().annotations_list()
             .volume_id("vero")
             .updated_min("consetetur")
             .updated_max("eos")
             .source("justo")
             .show_deleted(true)
             .page_token("gubergren")
             .max_results(17)
             .add_layer_ids("amet.")
             .layer_id("dolore")
             .content_version("magna")
             .doit();

Methods

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

fn doit(self) -> Result<(Response, Annotations)>

Perform the operation you have build so far.

fn volume_id(self, new_value: &str) -> MylibraryAnnotationListCall<'a, C, A>

The volume to restrict annotations to.

Sets the volume id query property to the given value.

fn updated_min(self, new_value: &str) -> MylibraryAnnotationListCall<'a, C, A>

RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

Sets the updated min query property to the given value.

fn updated_max(self, new_value: &str) -> MylibraryAnnotationListCall<'a, C, A>

RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

Sets the updated max query property to the given value.

fn source(self, new_value: &str) -> MylibraryAnnotationListCall<'a, C, A>

String to identify the originator of this request.

Sets the source query property to the given value.

fn show_deleted(self, new_value: bool) -> MylibraryAnnotationListCall<'a, C, A>

Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

Sets the show deleted query property to the given value.

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

The value of the nextToken from the previous page.

Sets the page token query property to the given value.

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

Maximum number of results to return

Sets the max results query property to the given value.

fn add_layer_ids(self, new_value: &str) -> MylibraryAnnotationListCall<'a, C, A>

The layer ID(s) to limit annotation by.

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

fn layer_id(self, new_value: &str) -> MylibraryAnnotationListCall<'a, C, A>

The layer ID to limit annotation by.

Sets the layer id query property to the given value.

fn content_version(
    self,
    new_value: &str
) -> MylibraryAnnotationListCall<'a, C, A>

The content version for the requested volume.

Sets the content version query property to the given value.

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

fn param<T>(self, name: T, value: T) -> MylibraryAnnotationListCall<'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) - 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. Overrides userIp if both are provided.
• 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) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

fn add_scope<T>(self, scope: T) -> MylibraryAnnotationListCall<'a, C, A> where
    T: 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.

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