Struct google_api_proto::google::cloud::timeseriesinsights::v1::SlicingParams

pub struct SlicingParams {
    pub dimension_names: Vec<String>,
    pub pinned_dimensions: Vec<PinnedDimension>,
}

Parameters that control how we slice the dataset and, optionally, filter slices that have some specific values on some dimensions (pinned dimensions).

Fields

dimension_names: Vec<String>

Required. Dimensions over which we will group the events in slices. The names specified here come from the [EventDimension.name][google.cloud.timeseriesinsights.v1.EventDimension.name] field. At least one dimension name must be specified. All dimension names that do not exist in the queried DataSet will be ignored.

Currently only dimensions that hold string values can be specified here.

pinned_dimensions: Vec<PinnedDimension>

Optional. We will only analyze slices for which [EvaluatedSlice.dimensions][google.cloud.timeseriesinsights.v1.EvaluatedSlice.dimensions] contain all of the following pinned dimensions. A query with a pinned dimension { name: "d3" stringVal: "v3" } will only analyze events which contain the dimension { name: "d3" stringVal: "v3" }. The [pinnedDimensions][google.cloud.timeseriesinsights.v1.SlicingParams.pinned_dimensions] and [dimensionNames][google.cloud.timeseriesinsights.v1.SlicingParams.dimension_names] fields can not share the same dimension names.

Example a valid specification:

{
   dimensionNames: \["d1", "d2"\],
   pinnedDimensions: [
     { name: "d3" stringVal: "v3" },
     { name: "d4" stringVal: "v4" }
   ]
}

In the previous example we will slice the dataset by dimensions “d1”, “d2”, “d3” and “d4”, but we will only analyze slices for which “d3=v3” and “d4=v4”.

The following example is invalid as “d2” is present in both dimensionNames and pinnedDimensions:

{
   dimensionNames: \["d1", "d2"\],
   pinnedDimensions: [
     { name: "d2" stringVal: "v2" },
     { name: "d4" stringVal: "v4" }
   ]
}

Trait Implementations

impl Clone for SlicingParams

fn clone(&self) -> SlicingParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlicingParams

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

Formats the value using the given formatter.

impl Default for SlicingParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for SlicingParams

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 SlicingParams

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