Struct google_people1::api::PersonListDirectoryPersonCall
source · pub struct PersonListDirectoryPersonCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Provides a list of domain profiles and domain contacts in the authenticated user’s domain directory. When the sync_token is specified, resources deleted since the last sync will be returned as a person with PersonMetadata.deleted set to true. When the page_token or sync_token is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at List the directory people that have changed.
A builder for the listDirectoryPeople 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().list_directory_people()
.sync_token("kasd")
.add_sources("et")
.request_sync_token(true)
.read_mask(&Default::default())
.page_token("et")
.page_size(-68)
.add_merge_sources("vero")
.doit().await;Implementations§
source§impl<'a, S> PersonListDirectoryPersonCall<'a, S>
impl<'a, S> PersonListDirectoryPersonCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, ListDirectoryPeopleResponse)>
pub async fn doit(self) -> Result<(Response<Body>, ListDirectoryPeopleResponse)>
Perform the operation you have build so far.
sourcepub fn sync_token(self, new_value: &str) -> PersonListDirectoryPersonCall<'a, S>
pub fn sync_token(self, new_value: &str) -> PersonListDirectoryPersonCall<'a, S>
Optional. A sync token, received from a previous response next_sync_token Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to people.listDirectoryPeople must match the first call that provided the sync token. More details about sync behavior at people.listDirectoryPeople.
Sets the sync token query property to the given value.
sourcepub fn add_sources(
self,
new_value: &str
) -> PersonListDirectoryPersonCall<'a, S>
pub fn add_sources( self, new_value: &str ) -> PersonListDirectoryPersonCall<'a, S>
Required. Directory sources to return.
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 request_sync_token(
self,
new_value: bool
) -> PersonListDirectoryPersonCall<'a, S>
pub fn request_sync_token( self, new_value: bool ) -> PersonListDirectoryPersonCall<'a, S>
Optional. Whether the response should return next_sync_token. It can be used to get incremental changes since the last request by setting it on the request sync_token. More details about sync behavior at people.listDirectoryPeople.
Sets the request sync token query property to the given value.
sourcepub fn read_mask(
self,
new_value: FieldMask
) -> PersonListDirectoryPersonCall<'a, S>
pub fn read_mask( self, new_value: FieldMask ) -> PersonListDirectoryPersonCall<'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 read mask query property to the given value.
sourcepub fn page_token(self, new_value: &str) -> PersonListDirectoryPersonCall<'a, S>
pub fn page_token(self, new_value: &str) -> PersonListDirectoryPersonCall<'a, S>
Optional. A page token, received from a previous response next_page_token. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to people.listDirectoryPeople must match the first call that provided the page token.
Sets the page token query property to the given value.
sourcepub fn page_size(self, new_value: i32) -> PersonListDirectoryPersonCall<'a, S>
pub fn page_size(self, new_value: i32) -> PersonListDirectoryPersonCall<'a, S>
Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
Sets the page size query property to the given value.
sourcepub fn add_merge_sources(
self,
new_value: &str
) -> PersonListDirectoryPersonCall<'a, S>
pub fn add_merge_sources( self, new_value: &str ) -> PersonListDirectoryPersonCall<'a, S>
Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
Append the given value to the merge sources query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> PersonListDirectoryPersonCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> PersonListDirectoryPersonCall<'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) -> PersonListDirectoryPersonCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> PersonListDirectoryPersonCall<'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) -> PersonListDirectoryPersonCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> PersonListDirectoryPersonCall<'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::DirectoryReadonly.
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
) -> PersonListDirectoryPersonCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> PersonListDirectoryPersonCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> PersonListDirectoryPersonCall<'a, S>
pub fn clear_scopes(self) -> PersonListDirectoryPersonCall<'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).