pub struct OrganizationApiproductRateplanListCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Lists all the rate plans for an API product.
A builder for the apiproducts.rateplans.list method supported by a organization resource.
It is not used directly, but through a OrganizationMethods
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.organizations().apiproducts_rateplans_list("parent")
.state("duo")
.start_key("ipsum")
.order_by("sed")
.expand(true)
.count(-50)
.doit().await;
Implementations§
source§impl<'a, S> OrganizationApiproductRateplanListCall<'a, S>
impl<'a, S> OrganizationApiproductRateplanListCall<'a, S>
sourcepub async fn doit(
self
) -> Result<(Response<Body>, GoogleCloudApigeeV1ListRatePlansResponse)>
pub async fn doit( self ) -> Result<(Response<Body>, GoogleCloudApigeeV1ListRatePlansResponse)>
Perform the operation you have build so far.
sourcepub fn parent(
self,
new_value: &str
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn parent( self, new_value: &str ) -> OrganizationApiproductRateplanListCall<'a, S>
Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
Use organizations/{org}/apiproducts/-
to return rate plans for all API products within the organization.
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.
sourcepub fn state(
self,
new_value: &str
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn state( self, new_value: &str ) -> OrganizationApiproductRateplanListCall<'a, S>
State of the rate plans (DRAFT
, PUBLISHED
) that you want to display.
Sets the state query property to the given value.
sourcepub fn start_key(
self,
new_value: &str
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn start_key( self, new_value: &str ) -> OrganizationApiproductRateplanListCall<'a, S>
Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of startKey
to the name of the 51st rate plan and set the value of count
to 100.
Sets the start key query property to the given value.
sourcepub fn order_by(
self,
new_value: &str
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn order_by( self, new_value: &str ) -> OrganizationApiproductRateplanListCall<'a, S>
Name of the attribute used for sorting. Valid values include: * name
: Name of the rate plan. * state
: State of the rate plan (DRAFT
, PUBLISHED
). * startTime
: Time when the rate plan becomes active. * endTime
: Time when the rate plan expires. Note: Not supported by Apigee at this time.
Sets the order by query property to the given value.
sourcepub fn expand(
self,
new_value: bool
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn expand( self, new_value: bool ) -> OrganizationApiproductRateplanListCall<'a, S>
Flag that specifies whether to expand the results. Set to true
to get expanded details about each API. Defaults to false
.
Sets the expand query property to the given value.
sourcepub fn count(
self,
new_value: i32
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn count( self, new_value: i32 ) -> OrganizationApiproductRateplanListCall<'a, S>
Number of rate plans to return in the API call. Use with the startKey
parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100.
Sets the count query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> OrganizationApiproductRateplanListCall<'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.
sourcepub fn param<T>(
self,
name: T,
value: T
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> OrganizationApiproductRateplanListCall<'a, S>
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”).
sourcepub fn add_scope<St>(
self,
scope: St
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> OrganizationApiproductRateplanListCall<'a, S>
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::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.
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.
sourcepub fn add_scopes<I, St>(
self,
scopes: I
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> OrganizationApiproductRateplanListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn clear_scopes(self) -> OrganizationApiproductRateplanListCall<'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).