Struct google_cloudresourcemanager1::ProjectListCall

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

Lists Projects that the caller has the resourcemanager.projects.get permission on and satisfy the specified filter.

This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.

NOTE: If the request filter contains a parent.type and parent.id and the caller has the resourcemanager.projects.list permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavorial difference.

A builder for the 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().list()
             .page_token("no")
             .page_size(-36)
             .filter("eirmod")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.

Optional.

Sets the page token query property to the given value.

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

The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default.

Optional.

Sets the page size query property to the given value.

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

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

• name
• id
• labels.<key> (where key is the name of a label)
• parent.type
• parent.id

Some examples of using labels as filters:

Filter	Description
name:how*	The project's name starts with "how".
name:Howl	The project's name is Howl or howl.
name:HOWL	Equivalent to above.
NAME:howl	Equivalent to above.
labels.color:*	The project has the label color.
labels.color:red	The project's label color has the value red.
labels.color:red labels.size:big	The project's label color has
the value red and its label size has the value big.

If no filter is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the resourcemanager.projects.list permission on the parent and the filter must contain both a parent.type and a parent.id restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results.

Optional.

Sets the filter query property to the given value.

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

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