Struct google_photoslibrary1::api::AlbumPatchCall[−][src]

pub struct AlbumPatchCall<'a> { /* fields omitted */ }

Expand description

Update the album with the specified id. Only the id, title and cover_photo_media_item_id fields of the album are read. The album must have been created by the developer via the API and must be owned by the user.

A builder for the patch method supported by a album resource. It is not used directly, but through a AlbumMethods instance.

Example

Instantiate a resource method builder

use photoslibrary1::api::Album;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Album::default();
 
// 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.albums().patch(req, "id")
             .update_mask("amet")
             .doit().await;

Implementations

[src]

impl<'a> AlbumPatchCall<'a>

[src]

pub async fn doit(self) -> Result<(Response<Body>, Album )>

Perform the operation you have build so far.

[src]

pub fn request(self, new_value: Album) -> AlbumPatchCall<'a>

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

[src]

pub fn id(self, new_value: &str) -> AlbumPatchCall<'a>

Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.

Sets the 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.

[src]

pub fn update_mask(self, new_value: &str) -> AlbumPatchCall<'a>

Required. Indicate what fields in the provided album to update. The only valid values are title and cover_photo_media_item_id.

Sets the update mask query property to the given value.

[src]

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

[src]

pub fn param<T>(self, name: T, value: T) -> AlbumPatchCall<'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

$.xgafv (query-string) - V1 error format.
access_token (query-string) - OAuth access token.
alt (query-string) - Data format for response.
callback (query-string) - JSONP
fields (query-string) - Selector specifying which fields to include in a partial response.
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.
oauth_token (query-string) - OAuth 2.0 token for the current user.
prettyPrint (query-boolean) - Returns response with indentations and line breaks.
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.
uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

[src]

pub fn add_scope<T, S>(self, scope: T) -> AlbumPatchCall<'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::EditAppcreateddata.

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.