Struct ListTimeSeriesRequest

#[non_exhaustive]
pub struct ListTimeSeriesRequest {
    pub name: String,
    pub filter: String,
    pub interval: Option<TimeInterval>,
    pub aggregation: Option<Aggregation>,
    pub secondary_aggregation: Option<Aggregation>,
    pub order_by: String,
    pub view: TimeSeriesView,
    pub page_size: i32,
    pub page_token: String,
}

The ListTimeSeries request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Required. The project, organization or folder on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]

filter: String

Required. 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"

interval: Option<TimeInterval>

Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

aggregation: Option<Aggregation>

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.

secondary_aggregation: Option<Aggregation>

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

order_by: String

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

view: TimeSeriesView

Required. Specifies which information is returned about the time series.

page_size: i32

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.

page_token: String

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.

Implementations

impl ListTimeSeriesRequest

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

pub fn set_interval<T: Into<Option<TimeInterval>>>(self, v: T) -> Self

Sets the value of interval.

pub fn set_aggregation<T: Into<Option<Aggregation>>>(self, v: T) -> Self

Sets the value of aggregation.

pub fn set_secondary_aggregation<T: Into<Option<Aggregation>>>( self, v: T, ) -> Self

Sets the value of secondary_aggregation.

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

Sets the value of order_by.

pub fn set_view<T: Into<TimeSeriesView>>(self, v: T) -> Self

Sets the value of view.

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Trait Implementations

impl Clone for ListTimeSeriesRequest

fn clone(&self) -> ListTimeSeriesRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListTimeSeriesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListTimeSeriesRequest

fn default() -> ListTimeSeriesRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListTimeSeriesRequest

where ListTimeSeriesRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ListTimeSeriesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListTimeSeriesRequest

fn eq(&self, other: &ListTimeSeriesRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ListTimeSeriesRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListTimeSeriesRequest