Struct google_people1::api::PersonGetBatchGetCall
source · pub struct PersonGetBatchGetCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
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 returns a 400 error if ‘personFields’ is not specified.
A builder for the getBatchGet method supported by a person resource.
It is not used directly, but through a PersonMethods
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_sources("no")
.add_resource_names("Stet")
.request_mask_include_field(&Default::default())
.person_fields(&Default::default())
.doit().await;
Implementations§
source§impl<'a, S> PersonGetBatchGetCall<'a, S>
impl<'a, S> PersonGetBatchGetCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, GetPeopleResponse)>
pub async fn doit(self) -> Result<(Response<Body>, GetPeopleResponse)>
Perform the operation you have build so far.
sourcepub fn add_sources(self, new_value: &str) -> PersonGetBatchGetCall<'a, S>
pub fn add_sources(self, new_value: &str) -> PersonGetBatchGetCall<'a, S>
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
Append the given value to the sources query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
sourcepub fn add_resource_names(self, new_value: &str) -> PersonGetBatchGetCall<'a, S>
pub fn add_resource_names(self, new_value: &str) -> PersonGetBatchGetCall<'a, S>
Required. The resource names of the people to provide information about. It’s repeatable. The URL query parameter should be resourceNames=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
. There is a maximum of 200 resource names.
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.
sourcepub fn request_mask_include_field(
self,
new_value: FieldMask
) -> PersonGetBatchGetCall<'a, S>
pub fn request_mask_include_field( self, new_value: FieldMask ) -> PersonGetBatchGetCall<'a, S>
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.
sourcepub fn person_fields(self, new_value: FieldMask) -> PersonGetBatchGetCall<'a, S>
pub fn person_fields(self, new_value: FieldMask) -> PersonGetBatchGetCall<'a, S>
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 * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
Sets the person fields query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> PersonGetBatchGetCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> PersonGetBatchGetCall<'a, S>
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.
sourcepub fn param<T>(self, name: T, value: T) -> PersonGetBatchGetCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> PersonGetBatchGetCall<'a, S>
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”).
sourcepub fn add_scope<St>(self, scope: St) -> PersonGetBatchGetCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> PersonGetBatchGetCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of 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.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> PersonGetBatchGetCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> PersonGetBatchGetCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> PersonGetBatchGetCall<'a, S>
pub fn clear_scopes(self) -> PersonGetBatchGetCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key
parameter (see Self::param()
for details).