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.

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("dolores")
             .request_mask_include_field("gubergren")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The resource name, such as one returned by people.connections.list, of one of the people to provide information about. You can include this parameter up to 50 times 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.

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

Comma-separated list of fields to be included in the response. Omitting this field will include all fields except for connections.list requests, which have a default mask that includes common fields like metadata, name, photo, and profile url. 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.

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

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 paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• bearer_token (query-string) - OAuth bearer token.
• pp (query-boolean) - Pretty-print response.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• 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.

fn add_scope<T>(self, scope: T) -> PeopleGetBatchGetCall<'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::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.

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>