Struct google_cloudchannel1::api::AccountOfferListCall

source ·

pub struct AccountOfferListCall<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

A builder for the offers.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().offers_list("parent")
             .show_future_offers(true)
             .page_token("et")
             .page_size(-23)
             .language_code("voluptua.")
             .filter("dolore")
             .doit().await;

Implementations§

source §

impl<'a, S> AccountOfferListCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

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

Perform the operation you have build so far.

source

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

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

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.

source

pub fn show_future_offers(self, new_value: bool) -> AccountOfferListCall<'a, S>

Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

Sets the show future offers query property to the given value.

source

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

Optional. A token for a page of results other than the first page.

Sets the page token query property to the given value.

source

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

Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

Sets the page size query property to the given value.

source

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

Optional. The BCP-47 language code. For example, “en-US”. The response will localize in the corresponding language code, if specified. The default value is “en-US”.

Sets the language code query property to the given value.

source

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

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

Sets the filter query property to the given value.

source

pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> AccountOfferListCall<'a, S>

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.

source

pub fn param<T>(self, name: T, value: T) -> AccountOfferListCall<'a, S>
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”).

source

pub fn add_scope<St>(self, scope: St) -> AccountOfferListCall<'a, S>
where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of the default Scope variant Scope::AppOrder.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

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.

source

pub fn add_scopes<I, St>(self, scopes: I) -> AccountOfferListCall<'a, S>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

source

pub fn clear_scopes(self) -> AccountOfferListCall<'a, S>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).