Struct google_firebase1_beta1::ProjectAvailableLocationListCall

pub struct ProjectAvailableLocationListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Returns a list of valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).

The default GCP resource location of a project defines the geographical location where project resources, such as Cloud Firestore, will be provisioned by default.

The returned list are the available GCP resource locations.

This call checks for any location restrictions for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a projectId (that is, /v1beta1/{parent=projects/-}/listAvailableLocations).

To call ListAvailableLocations with a specified project, a member must be at minimum a Viewer of the project. Calls without a specified project do not require any specific project permissions.

A builder for the availableLocations.list method supported by a project resource. It is not used directly, but through a ProjectMethods 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.projects().available_locations_list("parent")
             .page_token("eos")
             .page_size(-81)
             .doit();

Methods

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

pub fn doit(self) -> Result<(Response, ListAvailableLocationsResponse)>

Perform the operation you have build so far.

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

The Project for which to list GCP resource locations, in the format:
projects/projectId
If no project is specified (that is, projects/-), the returned list does not take into account org-specific or project-specific location restrictions.

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.

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

Token returned from a previous call to ListAvailableLocations indicating where in the list of locations to resume listing.

Sets the page token query property to the given value.

pub fn page_size(
    self,
    new_value: i32
) -> ProjectAvailableLocationListCall<'a, C, A>

The maximum number of locations to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative.

Sets the page size query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> ProjectAvailableLocationListCall<'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
) -> ProjectAvailableLocationListCall<'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 parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

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

pub fn add_scope<T, S>(
    self,
    scope: T
) -> ProjectAvailableLocationListCall<'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::Readonly.

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 ProjectAvailableLocationListCall<'a, C, A>