pub struct OrganizationEnvironmentStatGetCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the stats API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
A builder for the environments.stats.get 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().environments_stats_get("name")
.tzo("dolor")
.ts_ascending(true)
.topk("consetetur")
.time_unit("et")
.time_range("sit")
.sortby("Lorem")
.sort("nonumy")
.sonar(false)
.select("ipsum")
.realtime(true)
.offset("Stet")
.limit("voluptua.")
.filter("At")
.agg_table("diam")
.accuracy("amet")
.doit().await;Implementations§
source§impl<'a, S> OrganizationEnvironmentStatGetCall<'a, S>
impl<'a, S> OrganizationEnvironmentStatGetCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, GoogleCloudApigeeV1Stats)>
pub async fn doit(self) -> Result<(Response<Body>, GoogleCloudApigeeV1Stats)>
Perform the operation you have build so far.
sourcepub fn name(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn name(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
Required. Resource name for which the interactive query will be executed. Use the following format in your request: organizations/{org}/environments/{env}/stats/{dimensions} Dimensions let you view metrics in meaningful groupings, such as apiproxy or target_host. The value of dimensions should be a comma-separated list, as shown below: organizations/{org}/environments/{env}/stats/apiproxy,request_verb
Sets the name 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 tzo(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn tzo(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
Timezone offset value.
Sets the tzo query property to the given value.
sourcepub fn ts_ascending(
self,
new_value: bool
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn ts_ascending( self, new_value: bool ) -> OrganizationEnvironmentStatGetCall<'a, S>
Flag that specifies whether to list timestamps in ascending (true) or descending (false) order. Apigee recommends that you set this value to true if you are using sortby with sort=DESC.
Sets the ts ascending query property to the given value.
sourcepub fn topk(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn topk(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
Top number of results to return. For example, to return the top 5 results, set topk=5.
Sets the topk query property to the given value.
sourcepub fn time_unit(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn time_unit( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Granularity of metrics returned. Valid values include: second, minute, hour, day, week, or month.
Sets the time unit query property to the given value.
sourcepub fn time_range(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn time_range( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Time interval for the interactive query. Time range is specified in GMT as start~end. For example: 04/15/2017 00:00~05/15/2017 23:59
Sets the time range query property to the given value.
sourcepub fn sortby(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn sortby( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Comma-separated list of columns to sort the final result.
Sets the sortby query property to the given value.
sourcepub fn sort(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn sort(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
Flag that specifies whether the sort order should be ascending or descending. Valid values include: DESC and ASC.
Sets the sort query property to the given value.
sourcepub fn sonar(self, new_value: bool) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn sonar(self, new_value: bool) -> OrganizationEnvironmentStatGetCall<'a, S>
Routes the query to API Monitoring for the last hour.
Sets the sonar query property to the given value.
sourcepub fn select(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn select( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Comma-separated list of metrics. For example: sum(message_count),sum(error_count)
Sets the select query property to the given value.
sourcepub fn realtime(
self,
new_value: bool
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn realtime( self, new_value: bool ) -> OrganizationEnvironmentStatGetCall<'a, S>
No longer used by Apigee. Supported for backwards compatibility.
Sets the realtime query property to the given value.
sourcepub fn offset(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn offset( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Offset value. Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to 10 and offset to 10.
Sets the offset query property to the given value.
sourcepub fn limit(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn limit(self, new_value: &str) -> OrganizationEnvironmentStatGetCall<'a, S>
Maximum number of result items to return. The default and maximum value that can be returned is 14400.
Sets the limit query property to the given value.
sourcepub fn filter(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn filter( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Filter that enables you to drill down on specific dimension values.
Sets the filter query property to the given value.
sourcepub fn agg_table(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn agg_table( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.
Sets the agg table query property to the given value.
sourcepub fn accuracy(
self,
new_value: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn accuracy( self, new_value: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
No longer used by Apigee. Supported for backwards compatibility.
Sets the accuracy query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> OrganizationEnvironmentStatGetCall<'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
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> OrganizationEnvironmentStatGetCall<'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
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> OrganizationEnvironmentStatGetCall<'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
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> OrganizationEnvironmentStatGetCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn clear_scopes(self) -> OrganizationEnvironmentStatGetCall<'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).