Struct google_apigee1::api::OrganizationHostStatGetCall[−][src]

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

Retrieve metrics grouped by dimensions in host level. 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. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

A builder for the hostStats.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().host_stats_get("name")
             .tzo("diam")
             .ts_ascending(true)
             .topk("Lorem")
             .time_unit("At")
             .time_range("diam")
             .sortby("diam")
             .sort("sed")
             .select("et")
             .realtime(false)
             .offset("ipsum")
             .limit("ea")
             .filter("At")
             .envgroup_hostname("sit")
             .accuracy("sit")
             .doit().await;

Implementations

`impl<'a, C> OrganizationHostStatGetCall<'a, C> where C: BorrowMut<Client<HttpsConnector<HttpConnector>, Body>>,` [src]

`pub async fn doit(self) -> Result<(Response<Body>, GoogleCloudApigeeV1Stats)>`[src]

Perform the operation you have build so far.

`pub fn name(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

Required. The resource name for which the interactive query will be executed. Must be of the form organizations/{organization_id}/hostStats/{dimensions}. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below organizations/{org}/hostStats/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.

`pub fn tzo(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

This parameters contains the timezone offset value.

Sets the tzo query property to the given value.

`pub fn ts_ascending(self, new_value: bool) -> OrganizationHostStatGetCall<'a, C>`[src]

Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.

Sets the ts ascending query property to the given value.

`pub fn topk(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

Take ‘top k’ results from results, for example, to return the top 5 results ‘topk=5’.

Sets the topk query property to the given value.

`pub fn time_unit(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.

Sets the time unit query property to the given value.

`pub fn time_range(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59

Sets the time range query property to the given value.

`pub fn sortby(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

Comma separated list of columns to sort the final result.

Sets the sortby query property to the given value.

`pub fn sort(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.

Sets the sort query property to the given value.

`pub fn select(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)

Sets the select query property to the given value.

`pub fn realtime(self, new_value: bool) -> OrganizationHostStatGetCall<'a, C>`[src]

Legacy field: not used anymore.

Sets the realtime query property to the given value.

`pub fn offset(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

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.

`pub fn limit(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

This parameter is used to limit the number of result items. Default and the max value is 14400.

Sets the limit query property to the given value.

`pub fn filter(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

Enables drill-down on specific dimension values.

Sets the filter query property to the given value.

`pub fn envgroup_hostname( self, new_value: &str ) -> OrganizationHostStatGetCall<'a, C>`[src]

Required. The hostname for which the interactive query will be executed.

Sets the envgroup hostname query property to the given value.

`pub fn accuracy(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>`[src]

Legacy field: not used anymore.

Sets the accuracy query property to the given value.

`pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> OrganizationHostStatGetCall<'a, C>`[src]

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) -> OrganizationHostStatGetCall<'a, C> where T: AsRef<str>,` [src]

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”).

`pub fn add_scope<T, S>(self, scope: T) -> OrganizationHostStatGetCall<'a, C> where T: Into<Option<S>>, S: AsRef<str>,` [src]

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::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. 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> CallBuilder for OrganizationHostStatGetCall<'a, C>`[src]

Auto Trait Implementations

`impl<'a, C> !RefUnwindSafe for OrganizationHostStatGetCall<'a, C>`

`impl<'a, C> !Send for OrganizationHostStatGetCall<'a, C>`

`impl<'a, C> !Sync for OrganizationHostStatGetCall<'a, C>`

`impl<'a, C> Unpin for OrganizationHostStatGetCall<'a, C>`

`impl<'a, C> !UnwindSafe for OrganizationHostStatGetCall<'a, C>`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T> Instrument for T`[src]

`pub fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`pub fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct google_apigee1::api::OrganizationHostStatGetCall[−][src]

Example

Implementations

impl<'a, C> OrganizationHostStatGetCall<'a, C> where C: BorrowMut<Client<HttpsConnector<HttpConnector>, Body>>, [src]

pub async fn doit(self) -> Result<(Response<Body>, GoogleCloudApigeeV1Stats)>[src]

pub fn name(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn tzo(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn ts_ascending(self, new_value: bool) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn topk(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn time_unit(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn time_range(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn sortby(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn sort(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn select(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn realtime(self, new_value: bool) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn offset(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn limit(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn filter(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn envgroup_hostname( self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn accuracy(self, new_value: &str) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn delegate( self, new_value: &'a mut dyn Delegate) -> OrganizationHostStatGetCall<'a, C>[src]

pub fn param<T>(self, name: T, value: T) -> OrganizationHostStatGetCall<'a, C> where T: AsRef<str>, [src]

Additional Parameters

pub fn add_scope<T, S>(self, scope: T) -> OrganizationHostStatGetCall<'a, C> where T: Into<Option<S>>, S: AsRef<str>, [src]

Trait Implementations

impl<'a, C> CallBuilder for OrganizationHostStatGetCall<'a, C>[src]

Auto Trait Implementations

impl<'a, C> !RefUnwindSafe for OrganizationHostStatGetCall<'a, C>

impl<'a, C> !Send for OrganizationHostStatGetCall<'a, C>

impl<'a, C> !Sync for OrganizationHostStatGetCall<'a, C>

impl<'a, C> Unpin for OrganizationHostStatGetCall<'a, C>

impl<'a, C> !UnwindSafe for OrganizationHostStatGetCall<'a, C>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T> Instrument for T[src]

pub fn instrument(self, span: Span) -> Instrumented<Self>[src]

pub fn in_current_span(self) -> Instrumented<Self>[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]