Struct AggregateInstancesRequest 

pub struct AggregateInstancesRequest {
    pub query: Option<String>,
    pub properties: Option<Vec<String>>,
    pub limit: Option<i32>,
    pub aggregates: Option<Vec<InstancesAggregate>>,
    pub group_by: Option<Vec<String>>,
    pub filter: Option<AdvancedFilter>,
    pub instance_type: InstanceType,
    pub view: TaggedViewReference,
}

Request for aggregating accross instances.

Fields

query: Option<String>

Optional query string. The API will parse the query string, and use it to match the text properties on elements to use for the aggregate(s).

properties: Option<Vec<String>>

Optional list of properties to apply the query to. If no properties are listed, text fields are searched by default.

limit: Option<i32>

Maximum number of results to return. The default is 100, maximum is 1000.

aggregates: Option<Vec<InstancesAggregate>>

List of aggregates to calculate.

group_by: Option<Vec<String>>

The selection of fields to group the results by when doing aggregations.

When you do not specify any aggregates. The fields in the groupBy clause will return the unique values stored for each field.

filter: Option<AdvancedFilter>

Optional filter on nodes or edges.

instance_type: InstanceType

Instance type to aggregate accross.

view: TaggedViewReference

Reference to a view to query.

Trait Implementations

impl Clone for AggregateInstancesRequest

fn clone(&self) -> AggregateInstancesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AggregateInstancesRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AggregateInstancesRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AggregateInstancesRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.