Struct google_apigee1::api::GoogleCloudApigeeV1Query

pub struct GoogleCloudApigeeV1Query {
    pub csv_delimiter: Option<String>,
    pub dimensions: Option<Vec<String>>,
    pub envgroup_hostname: Option<String>,
    pub filter: Option<String>,
    pub group_by_time_unit: Option<String>,
    pub limit: Option<i32>,
    pub metrics: Option<Vec<GoogleCloudApigeeV1QueryMetric>>,
    pub name: Option<String>,
    pub output_format: Option<String>,
    pub report_definition_id: Option<String>,
    pub time_range: Option<String>,
}

There is no detailed description.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• environments queries create organizations (request)
• host queries create organizations (request)

Fields

csv_delimiter: Option<String>

Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).

dimensions: Option<Vec<String>>

A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions

envgroup_hostname: Option<String>

Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.

filter: Option<String>

Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax

group_by_time_unit: Option<String>

Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.

limit: Option<i32>

Maximum number of rows that can be returned in the result.

metrics: Option<Vec<GoogleCloudApigeeV1QueryMetric>>

A list of Metrics.

name: Option<String>

Asynchronous Query Name.

output_format: Option<String>

Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.

report_definition_id: Option<String>

Asynchronous Report ID.

time_range: Option<String>

Required. Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: “timeRange”: { “start”: “2018-07-29T00:13:00Z”, “end”: “2018-08-01T00:18:00Z” }

Trait Implementations

impl Clone for GoogleCloudApigeeV1Query

fn clone(&self) -> GoogleCloudApigeeV1Query

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleCloudApigeeV1Query

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

Formats the value using the given formatter.

impl Default for GoogleCloudApigeeV1Query

fn default() -> GoogleCloudApigeeV1Query

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudApigeeV1Query

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl RequestValue for GoogleCloudApigeeV1Query

impl Serialize for GoogleCloudApigeeV1Query

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

Serialize this value into the given Serde serializer.