Struct google_books1::LayerVolumeAnnotationListCall

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

Gets the volume annotations for a volume and layer.

A builder for the volumeAnnotations.list method supported by a layer resource. It is not used directly, but through a LayerMethods 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.layers().volume_annotations_list("volumeId", "layerId", "contentVersion")
             .volume_annotations_version("gubergren")
             .updated_min("justo")
             .updated_max("sit")
             .start_position("vero")
             .start_offset("diam")
             .source("rebum.")
             .show_deleted(true)
             .page_token("sadipscing")
             .max_results(25)
             .locale("sadipscing")
             .end_position("invidunt")
             .end_offset("consetetur")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The volume to retrieve annotations for.

Sets the volume 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 layer_id(
    self,
    new_value: &str
) -> LayerVolumeAnnotationListCall<'a, C, A>

The ID for the layer to get the annotations.

Sets the layer 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 content_version(
    self,
    new_value: &str
) -> LayerVolumeAnnotationListCall<'a, C, A>

The content version for the requested volume.

Sets the content version 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 volume_annotations_version(
    self,
    new_value: &str
) -> LayerVolumeAnnotationListCall<'a, C, A>

The version of the volume annotations that you are requesting.

Sets the volume annotations version query property to the given value.

pub fn updated_min(
    self,
    new_value: &str
) -> LayerVolumeAnnotationListCall<'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.

pub fn updated_max(
    self,
    new_value: &str
) -> LayerVolumeAnnotationListCall<'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.

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

The start position to start retrieving data from.

Sets the start position query property to the given value.

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

The start offset to start retrieving data from.

Sets the start offset query property to the given value.

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

String to identify the originator of this request.

Sets the source query property to the given value.

pub fn show_deleted(
    self,
    new_value: bool
) -> LayerVolumeAnnotationListCall<'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.

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

The value of the nextToken from the previous page.

Sets the page token query property to the given value.

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

Maximum number of results to return

Sets the max results query property to the given value.

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

The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

Sets the locale query property to the given value.

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

The end position to end retrieving data from.

Sets the end position query property to the given value.

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

The end offset to end retrieving data from.

Sets the end offset query property to the given value.

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

• 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
) -> LayerVolumeAnnotationListCall<'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 LayerVolumeAnnotationListCall<'a, C, A>