[][src]Struct google_compute1::InstanceGroupManagerListCall

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

Retrieves a list of managed instance groups that are contained within the specified project and zone.

A builder for the list method supported by a instanceGroupManager resource. It is not used directly, but through a InstanceGroupManagerMethods 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.instance_group_managers().list("project", "zone")
             .page_token("sanctus")
             .order_by("sanctus")
             .max_results(8)
             .filter("labore")
             .doit();

Methods

impl<'a, C, A> InstanceGroupManagerListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken
[src]

pub fn doit(self) -> Result<(Response, InstanceGroupManagerList)>[src]

Perform the operation you have build so far.

pub fn project(self, new_value: &str) -> InstanceGroupManagerListCall<'a, C, A>[src]

Project ID for this request.

Sets the project 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 zone(self, new_value: &str) -> InstanceGroupManagerListCall<'a, C, A>[src]

The name of the zone where the managed instance group is located.

Sets the zone 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
) -> InstanceGroupManagerListCall<'a, C, A>
[src]

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Sets the page token query property to the given value.

pub fn order_by(self, new_value: &str) -> InstanceGroupManagerListCall<'a, C, A>[src]

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Sets the order by query property to the given value.

pub fn max_results(
    self,
    new_value: u32
) -> InstanceGroupManagerListCall<'a, C, A>
[src]

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

Sets the max results query property to the given value.

pub fn filter(self, new_value: &str) -> InstanceGroupManagerListCall<'a, C, A>[src]

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

Sets the filter query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> InstanceGroupManagerListCall<'a, C, A>
[src]

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
) -> InstanceGroupManagerListCall<'a, C, A> where
    T: AsRef<str>, 
[src]

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

  • quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  • 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) - Deprecated. Please use quotaUser instead.
  • 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) -> InstanceGroupManagerListCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 
[src]

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 InstanceGroupManagerListCall<'a, C, A>[src]

Auto Trait Implementations

impl<'a, C, A> !Send for InstanceGroupManagerListCall<'a, C, A>

impl<'a, C, A> Unpin for InstanceGroupManagerListCall<'a, C, A>

impl<'a, C, A> !Sync for InstanceGroupManagerListCall<'a, C, A>

impl<'a, C, A> !UnwindSafe for InstanceGroupManagerListCall<'a, C, A>

impl<'a, C, A> !RefUnwindSafe for InstanceGroupManagerListCall<'a, C, A>

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Typeable for T where
    T: Any

fn get_type(&self) -> TypeId

Get the TypeId of this object.