Struct google_admin1_directory::UserListCall [−][src]
pub struct UserListCall<'a, C, A> where
C: 'a,
A: 'a, { /* fields omitted */ }
Retrieve either deleted users or all users in a domain (paginated)
A builder for the list method supported by a user resource.
It is not used directly, but through a UserMethods
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.users().list() .view_type("dolore") .sort_order("Lorem") .show_deleted("consetetur") .query("consetetur") .projection("eirmod") .page_token("labore") .order_by("gubergren") .max_results(-73) .event("sadipscing") .domain("accusam") .customer("magna") .custom_field_mask("Lorem") .doit();
Methods
impl<'a, C, A> UserListCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
impl<'a, C, A> UserListCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, Users)>
[src]
pub fn doit(self) -> Result<(Response, Users)>
Perform the operation you have build so far.
pub fn view_type(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn view_type(self, new_value: &str) -> UserListCall<'a, C, A>
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
Sets the view type query property to the given value.
pub fn sort_order(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn sort_order(self, new_value: &str) -> UserListCall<'a, C, A>
Whether to return results in ascending or descending order.
Sets the sort order query property to the given value.
pub fn show_deleted(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn show_deleted(self, new_value: &str) -> UserListCall<'a, C, A>
If set to true retrieves the list of deleted users. Default is false
Sets the show deleted query property to the given value.
pub fn query(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn query(self, new_value: &str) -> UserListCall<'a, C, A>
Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
Sets the query query property to the given value.
pub fn projection(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn projection(self, new_value: &str) -> UserListCall<'a, C, A>
What subset of fields to fetch for this user.
Sets the projection query property to the given value.
pub fn page_token(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn page_token(self, new_value: &str) -> UserListCall<'a, C, A>
Token to specify next page in the list
Sets the page token query property to the given value.
pub fn order_by(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn order_by(self, new_value: &str) -> UserListCall<'a, C, A>
Column to use for sorting results
Sets the order by query property to the given value.
pub fn max_results(self, new_value: i32) -> UserListCall<'a, C, A>
[src]
pub fn max_results(self, new_value: i32) -> UserListCall<'a, C, A>
Maximum number of results to return. Default is 100. Max allowed is 500
Sets the max results query property to the given value.
pub fn event(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn event(self, new_value: &str) -> UserListCall<'a, C, A>
Event on which subscription is intended (if subscribing)
Sets the event query property to the given value.
pub fn domain(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn domain(self, new_value: &str) -> UserListCall<'a, C, A>
Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
Sets the domain query property to the given value.
pub fn customer(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn customer(self, new_value: &str) -> UserListCall<'a, C, A>
Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
Sets the customer query property to the given value.
pub fn custom_field_mask(self, new_value: &str) -> UserListCall<'a, C, A>
[src]
pub fn custom_field_mask(self, new_value: &str) -> UserListCall<'a, C, A>
Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
Sets the custom field mask query property to the given value.
pub fn delegate(self, new_value: &'a mut Delegate) -> UserListCall<'a, C, A>
[src]
pub fn delegate(self, new_value: &'a mut Delegate) -> UserListCall<'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) -> UserListCall<'a, C, A> where
T: AsRef<str>,
[src]
pub fn param<T>(self, name: T, value: T) -> UserListCall<'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
- 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. Overrides userIp if both are provided.
- 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.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- alt (query-string) - Data format for the response.
pub fn add_scope<T, S>(self, scope: T) -> UserListCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
pub fn add_scope<T, S>(self, scope: T) -> UserListCall<'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::DirectoryUserReadonly
.
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 UserListCall<'a, C, A>
[src]
impl<'a, C, A> CallBuilder for UserListCall<'a, C, A>
Auto Trait Implementations
impl<'a, C, A> !Send for UserListCall<'a, C, A>
impl<'a, C, A> !Send for UserListCall<'a, C, A>
impl<'a, C, A> !Sync for UserListCall<'a, C, A>
impl<'a, C, A> !Sync for UserListCall<'a, C, A>