[][src]Struct google_monitoring3::ProjectTimeSeryListCall

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

Lists time series that match a filter. This method does not require a Stackdriver account.

A builder for the timeSeries.list method supported by a project resource. It is not used directly, but through a ProjectMethods 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.projects().time_series_list("name")
             .view("elitr")
             .page_token("amet")
             .page_size(-60)
             .order_by("labore")
             .interval_start_time("eirmod")
             .interval_end_time("dolore")
             .filter("invidunt")
             .aggregation_per_series_aligner("aliquyam")
             .add_aggregation_group_by_fields("accusam")
             .aggregation_cross_series_reducer("Lorem")
             .aggregation_alignment_period("sea")
             .doit();

Methods

impl<'a, C, A> ProjectTimeSeryListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken
[src]

pub fn doit(self) -> Result<(Response, ListTimeSeriesResponse)>[src]

Perform the operation you have build so far.

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

The project on which to execute the request. The format is "projects/{project_id_or_number}".

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 view(self, new_value: &str) -> ProjectTimeSeryListCall<'a, C, A>[src]

Specifies which information is returned about the time series.

Sets the view query property to the given value.

pub fn page_token(self, new_value: &str) -> ProjectTimeSeryListCall<'a, C, A>[src]

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Sets the page token query property to the given value.

pub fn page_size(self, new_value: i32) -> ProjectTimeSeryListCall<'a, C, A>[src]

A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.

Sets the page size query property to the given value.

pub fn order_by(self, new_value: &str) -> ProjectTimeSeryListCall<'a, C, A>[src]

Unsupported: must be left blank. The points in each time series are returned in reverse time order.

Sets the order by query property to the given value.

pub fn interval_start_time(
    self,
    new_value: &str
) -> ProjectTimeSeryListCall<'a, C, A>
[src]

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

Sets the interval.start time query property to the given value.

pub fn interval_end_time(
    self,
    new_value: &str
) -> ProjectTimeSeryListCall<'a, C, A>
[src]

Required. The end of the time interval.

Sets the interval.end time query property to the given value.

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

A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"

Sets the filter query property to the given value.

pub fn aggregation_per_series_aligner(
    self,
    new_value: &str
) -> ProjectTimeSeryListCall<'a, C, A>
[src]

The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

Sets the aggregation.per series aligner query property to the given value.

pub fn add_aggregation_group_by_fields(
    self,
    new_value: &str
) -> ProjectTimeSeryListCall<'a, C, A>
[src]

The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.

Append the given value to the aggregation.group by fields query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

pub fn aggregation_cross_series_reducer(
    self,
    new_value: &str
) -> ProjectTimeSeryListCall<'a, C, A>
[src]

The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

Sets the aggregation.cross series reducer query property to the given value.

pub fn aggregation_alignment_period(
    self,
    new_value: &str
) -> ProjectTimeSeryListCall<'a, C, A>
[src]

The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.

Sets the aggregation.alignment period query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> ProjectTimeSeryListCall<'a, C, A>
[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) -> ProjectTimeSeryListCall<'a, C, A> 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

  • upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • access_token (query-string) - OAuth access token.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • 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.
  • callback (query-string) - JSONP
  • oauth_token (query-string) - OAuth 2.0 token for the current user.
  • 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.
  • uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
  • alt (query-string) - Data format for response.
  • $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> ProjectTimeSeryListCall<'a, C, A> 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, A> CallBuilder for ProjectTimeSeryListCall<'a, C, A>[src]

Auto Trait Implementations

impl<'a, C, A> !Send for ProjectTimeSeryListCall<'a, C, A>

impl<'a, C, A> Unpin for ProjectTimeSeryListCall<'a, C, A>

impl<'a, C, A> !Sync for ProjectTimeSeryListCall<'a, C, A>

impl<'a, C, A> !UnwindSafe for ProjectTimeSeryListCall<'a, C, A>

impl<'a, C, A> !RefUnwindSafe for ProjectTimeSeryListCall<'a, C, A>

Blanket Implementations

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

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

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

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

impl<T> Typeable for T where
    T: Any

fn get_type(&self) -> TypeId

Get the TypeId of this object.