Struct google_apigee1::api::OrganizationAppListCall

source ·

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

Expand description

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

A builder for the apps.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().apps_list("parent")
             .status("sadipscing")
             .start_key("Lorem")
             .rows(-38)
             .page_token("no")
             .page_size(-7)
             .key_status("At")
             .include_cred(true)
             .ids("sit")
             .filter("et")
             .expand(true)
             .apptype("aliquyam")
             .api_product("ipsum")
             .doit().await;

Implementations§

source §

impl<'a, S> OrganizationAppListCall<'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>, GoogleCloudApigeeV1ListAppsResponse)>

Perform the operation you have build so far.

source

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

Required. Resource path of the parent in the following format: organizations/{org}

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 status(self, new_value: &str) -> OrganizationAppListCall<'a, S>

Optional. Filter by the status of the app. Valid values are approved or revoked. Defaults to approved.

Sets the status query property to the given value.

source

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

Returns the list of apps starting from the specified app ID.

Sets the start key query property to the given value.

source

pub fn rows(self, new_value: i64) -> OrganizationAppListCall<'a, S>

Optional. Maximum number of app IDs to return. Defaults to 10000.

Sets the rows query property to the given value.

source

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

Optional. The starting index record for listing the developers. “page_token” is supported from ver 1.10.0 and above.

Sets the page token query property to the given value.

source

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

Optional. Count of apps a single page can have in the response. If unspecified, at most 100 apps will be returned. The maximum value is 100; values above 100 will be coerced to 100. “page_size” is supported from ver 1.10.0 and above.

Sets the page size query property to the given value.

source

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

Optional. Key status of the app. Valid values include approved or revoked. Defaults to approved.

Sets the key status query property to the given value.

source

pub fn include_cred(self, new_value: bool) -> OrganizationAppListCall<'a, S>

Optional. Flag that specifies whether to include credentials in the response.

Sets the include cred query property to the given value.

source

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

Optional. Comma-separated list of app IDs on which to filter.

Sets the ids query property to the given value.

source

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

Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: “developerEmail=foo@bar.com”, “appType=AppGroup”, or “appType=Developer” “filter” is supported from ver 1.10.0 and above.

Sets the filter query property to the given value.

source

pub fn expand(self, new_value: bool) -> OrganizationAppListCall<'a, S>

Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.

Sets the expand query property to the given value.

source

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

Optional. ‘apptype’ is no longer available. Use a ‘filter’ instead.

Sets the apptype query property to the given value.

source

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

API product.

Sets the api product query property to the given value.

source

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

source

pub fn add_scopes<I, St>(self, scopes: I) -> OrganizationAppListCall<'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) -> OrganizationAppListCall<'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).