Struct google_api_proto::google::monitoring::v3::ListTimeSeriesRequest

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: i32,
    pub page_size: i32,
    pub page_token: String,
}

The ListTimeSeries request.

Fields

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: i32

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 view(&self) -> TimeSeriesView

Returns the enum value of view, or the default if the field is set to an invalid enum value.

pub fn set_view(&mut self, value: TimeSeriesView)

Sets view to the provided enum value.

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() -> Self

Returns the “default value” for a type.

impl Message for ListTimeSeriesRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListTimeSeriesRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListTimeSeriesRequest