Struct google_reseller1_sandbox::SubscriptionListCall

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

Lists subscriptions of a reseller, optionally filtered by a customer name prefix.

A builder for the list method supported by a subscription resource. It is not used directly, but through a SubscriptionMethods 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.subscriptions().list()
             .page_token("ipsum")
             .max_results(96)
             .customer_name_prefix("et")
             .customer_id("duo")
             .customer_auth_token("aliquyam")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

Token to specify next page in the list

Sets the page token query property to the given value.

pub fn max_results(self, new_value: u32) -> SubscriptionListCall<'a, C, A>

Maximum number of results to return

Sets the max results query property to the given value.

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

Prefix of the customer's domain name by which the subscriptions should be filtered. Optional

Sets the customer name prefix query property to the given value.

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

Id of the Customer

Sets the customer id query property to the given value.

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

An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.

Sets the customer auth token query property to the given value.

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

• 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) -> SubscriptionListCall<'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::AppOrderReadonly.

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