Struct google_mybusiness4::api::AccountLocationListCall[−][src]

pub struct AccountLocationListCall<'a> { /* fields omitted */ }

Expand description

Lists the locations for the specified account.

A builder for the locations.list method supported by a account resource. It is not used directly, but through a AccountMethods 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.accounts().locations_list("parent")
             .page_token("amet.")
             .page_size(-17)
             .order_by("sadipscing")
             .language_code("Lorem")
             .filter("invidunt")
             .doit().await;

Implementations

[src]

impl<'a> AccountLocationListCall<'a>

[src]

pub async fn doit(self) -> Result<(Response<Body>, ListLocationsResponse )>

Perform the operation you have build so far.

[src]

pub fn parent(self, new_value: &str) -> AccountLocationListCall<'a>

The name of the account to fetch locations from. If the Account is of AccountType PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly.

Sets the parent path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

[src]

pub fn page_token(self, new_value: &str) -> AccountLocationListCall<'a>

If specified, it fetches the next page of locations. The page token is returned by previous calls to ListLocations when there were more locations than could fit in the requested page size.

Sets the page token query property to the given value.

[src]

pub fn page_size(self, new_value: i32) -> AccountLocationListCall<'a>

How many locations to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.

Sets the page size query property to the given value.

[src]

pub fn order_by(self, new_value: &str) -> AccountLocationListCall<'a>

Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix “ desc“ should be added. Valid fields to order_by are location_name and store_code. For example: “location_name, store_code desc” or “location_name” or “store_code desc”

Sets the order by query property to the given value.

[src]

pub fn language_code(self, new_value: &str) -> AccountLocationListCall<'a>

The BCP 47 code of language to get display location properties in. If this language is not available, they will be provided in the language of the location. If neither is available, they will be provided in English.

Sets the language code query property to the given value.

[src]

pub fn filter(self, new_value: &str) -> AccountLocationListCall<'a>

A filter constraining the locations to return. The response includes only entries that match the filter. If filter is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account.

For more information about valid fields and example usage, see Work with Location Data Guide.

Sets the filter query property to the given value.

[src]

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

[src]

pub fn param<T>(self, name: T, value: T) -> AccountLocationListCall<'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

$.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”).