Struct google_api_proto::google::cloud::timeseriesinsights::v1::QueryDataSetRequest

pub struct QueryDataSetRequest {
    pub name: String,
    pub detection_time: Option<Timestamp>,
    pub num_returned_slices: Option<i32>,
    pub slicing_params: Option<SlicingParams>,
    pub timeseries_params: Option<TimeseriesParams>,
    pub forecast_params: Option<ForecastParams>,
    pub return_timeseries: bool,
}

Request for performing a query against a loaded DataSet.

Fields

name: String

Required. Loaded DataSet to be queried in the format of “projects/{project}/datasets/{dataset}”

detection_time: Option<Timestamp>

Required. This is the point in time that we want to probe for anomalies.

The corresponding [TimeseriesPoint][google.cloud.timeseriesinsights.v1.TimeseriesPoint] is referred to as the detection point.

NOTE: As with any other time series point, the value is given by aggregating all events in the slice that are in the [detectionTime, detectionTime + granularity) time interval, where the granularity is specified in the [timeseriesParams.granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] field.

num_returned_slices: Option<i32>

How many slices are returned in [QueryDataSetResponse.slices][google.cloud.timeseriesinsights.v1.QueryDataSetResponse.slices].

The returned slices are tentatively the ones with the highest [anomaly scores][google.cloud.timeseriesinsights.v1.EvaluatedSlice.anomaly_score] in the dataset that match the query, but it is not guaranteed.

Reducing this number will improve query performance, both in terms of latency and resource usage.

Defaults to 50.

slicing_params: Option<SlicingParams>

Parameters controlling how we will split the dataset into the slices that we will analyze.

timeseries_params: Option<TimeseriesParams>

Parameters controlling how we will build the time series used to predict the [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] value for each slice.

forecast_params: Option<ForecastParams>

Parameters that control the time series forecasting models, such as the sensitivity of the anomaly detection.

return_timeseries: bool

If specified, we will return the actual and forecasted time for all returned slices.

The time series are returned in the [EvaluatedSlice.history][google.cloud.timeseriesinsights.v1.EvaluatedSlice.history] and [EvaluatedSlice.forecast][google.cloud.timeseriesinsights.v1.EvaluatedSlice.forecast] fields.

Implementations

impl QueryDataSetRequest

pub fn num_returned_slices(&self) -> i32

Returns the value of num_returned_slices, or the default value if num_returned_slices is unset.

Trait Implementations

impl Clone for QueryDataSetRequest

fn clone(&self) -> QueryDataSetRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryDataSetRequest

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

Formats the value using the given formatter.

impl Default for QueryDataSetRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for QueryDataSetRequest

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for QueryDataSetRequest

fn eq(&self, other: &QueryDataSetRequest) -> 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 QueryDataSetRequest