Struct google_people1::PeopleGetBatchGetCall

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

Provides information about a list of specific people by specifying a list of requested resource names. Use people/me to indicate the authenticated user.

The request throws a 400 error if 'personFields' is not specified.

A builder for the getBatchGet method supported by a people resource. It is not used directly, but through a PeopleMethods 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.people().get_batch_get()
             .add_resource_names("eirmod")
             .request_mask_include_field("elitr")
             .person_fields("amet")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

Required. The resource names of the people to provide information about.

• To get information about the authenticated user, specify people/me.
• To get information about a google account, specify people/{account_id}.
• To get information about a contact, specify the resource name that identifies the contact as returned by people.connections.list.

You can include up to 50 resource names in one request.

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

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

Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person.photos.

Sets the request mask.include field query property to the given value.

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

Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are:

• addresses
• ageRanges
• biographies
• birthdays
• coverPhotos
• emailAddresses
• events
• genders
• imClients
• interests
• locales
• memberships
• metadata
• names
• nicknames
• occupations
• organizations
• phoneNumbers
• photos
• relations
• residences
• sipAddresses
• skills
• urls
• userDefined

Sets the person fields query property to the given value.

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

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