Package com.mypurecloud.sdk.v2.model

Class UserAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.UserAggregationQuery

All Implemented Interfaces:

Serializable

public class UserAggregationQuery
extends Object
implements Serializable

UserAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserAggregationQuery.AlternateTimeDimensionEnum	Dimension to use as the alternative timestamp for data in the aggregate.
static enum	UserAggregationQuery.GroupByEnum	Gets or Sets groupBy
static enum	UserAggregationQuery.MetricsEnum	Gets or Sets metrics

Constructor Summary

Constructors

Constructor	Description
UserAggregationQuery()
UserAggregationQuery(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
UserAggregationQuery	alternateTimeDimension(UserAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)	Dimension to use as the alternative timestamp for data in the aggregate.
boolean	equals(Object o)
UserAggregationQuery	filter(UserAggregateQueryFilter filter)	Behaves like a SQL WHERE clause.
UserAggregationQuery	flattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)	Flattens any multivalued dimensions used in response groups (e.g.
UserAggregationQuery.AlternateTimeDimensionEnum	getAlternateTimeDimension()
UserAggregateQueryFilter	getFilter()
Boolean	getFlattenMultivaluedDimensions()
String	getGranularity()
List<UserAggregationQuery.GroupByEnum>	getGroupBy()
String	getInterval()
List<UserAggregationQuery.MetricsEnum>	getMetrics()
String	getTimeZone()
List<UserAggregationView>	getViews()
UserAggregationQuery	granularity(String granularity)	Granularity aggregates metrics into subpartitions within the time interval specified.
UserAggregationQuery	groupBy(List<UserAggregationQuery.GroupByEnum> groupBy)	Behaves like a SQL GROUPBY.
int	hashCode()
UserAggregationQuery	interval(String interval)	Behaves like one clause in a SQL WHERE.
UserAggregationQuery	metrics(List<UserAggregationQuery.MetricsEnum> metrics)	Behaves like a SQL SELECT clause.
void	setAlternateTimeDimension(UserAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)
void	setFilter(UserAggregateQueryFilter filter)
void	setFlattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)
void	setGranularity(String granularity)
void	setGroupBy(List<UserAggregationQuery.GroupByEnum> groupBy)
void	setInterval(String interval)
void	setMetrics(List<UserAggregationQuery.MetricsEnum> metrics)
void	setTimeZone(String timeZone)
void	setViews(List<UserAggregationView> views)
UserAggregationQuery	timeZone(String timeZone)	Time zone context used to calculate response intervals (this allows resolving DST changes).
String	toString()
UserAggregationQuery	views(List<UserAggregationView> views)	Custom derived metric views

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserAggregationQuery

public UserAggregationQuery()

UserAggregationQuery

public UserAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

public UserAggregationQuery interval(String interval)

Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss

getInterval

public String getInterval()

setInterval

public void setInterval(String interval)

granularity

public UserAggregationQuery granularity(String granularity)

Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H

getGranularity

public String getGranularity()

setGranularity

public void setGranularity(String granularity)

timeZone

public UserAggregationQuery timeZone(String timeZone)

Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZone)

groupBy

public UserAggregationQuery groupBy(List<UserAggregationQuery.GroupByEnum> groupBy)

Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.

getGroupBy

public List<UserAggregationQuery.GroupByEnum> getGroupBy()

setGroupBy

public void setGroupBy(List<UserAggregationQuery.GroupByEnum> groupBy)

filter

public UserAggregationQuery filter(UserAggregateQueryFilter filter)

Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters

getFilter

public UserAggregateQueryFilter getFilter()

setFilter

public void setFilter(UserAggregateQueryFilter filter)

metrics

public UserAggregationQuery metrics(List<UserAggregationQuery.MetricsEnum> metrics)

Behaves like a SQL SELECT clause. Only named metrics will be retrieved.

getMetrics

public List<UserAggregationQuery.MetricsEnum> getMetrics()

setMetrics

public void setMetrics(List<UserAggregationQuery.MetricsEnum> metrics)

flattenMultivaluedDimensions

public UserAggregationQuery flattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)

Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')

getFlattenMultivaluedDimensions

public Boolean getFlattenMultivaluedDimensions()

setFlattenMultivaluedDimensions

public void setFlattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)

views

public UserAggregationQuery views(List<UserAggregationView> views)

Custom derived metric views

getViews

public List<UserAggregationView> getViews()

setViews

public void setViews(List<UserAggregationView> views)

alternateTimeDimension

public UserAggregationQuery alternateTimeDimension(UserAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.

getAlternateTimeDimension

public UserAggregationQuery.AlternateTimeDimensionEnum getAlternateTimeDimension()

setAlternateTimeDimension

public void setAlternateTimeDimension(UserAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object