Package com.mypurecloud.sdk.v2.model

Class ActionAsyncAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.ActionAsyncAggregationQuery

All Implemented Interfaces:

Serializable

public class ActionAsyncAggregationQuery
extends Object
implements Serializable

ActionAsyncAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ActionAsyncAggregationQuery()
ActionAsyncAggregationQuery(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ActionAsyncAggregationQuery

public ActionAsyncAggregationQuery()

ActionAsyncAggregationQuery

public ActionAsyncAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

public ActionAsyncAggregationQuery 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 ActionAsyncAggregationQuery 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 ActionAsyncAggregationQuery 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 ActionAsyncAggregationQuery groupBy(List<ActionAsyncAggregationQuery.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<ActionAsyncAggregationQuery.GroupByEnum> getGroupBy()

setGroupBy

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

filter

public ActionAsyncAggregationQuery filter(ActionAggregateQueryFilter 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 ActionAggregateQueryFilter getFilter()

setFilter

public void setFilter(ActionAggregateQueryFilter filter)

metrics

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

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

getMetrics

public List<ActionAsyncAggregationQuery.MetricsEnum> getMetrics()

setMetrics

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

flattenMultivaluedDimensions

public ActionAsyncAggregationQuery 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 ActionAsyncAggregationQuery views(List<ActionAggregationView> views)

Custom derived metric views

getViews

public List<ActionAggregationView> getViews()

setViews

public void setViews(List<ActionAggregationView> views)

alternateTimeDimension

public ActionAsyncAggregationQuery alternateTimeDimension(ActionAsyncAggregationQuery.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 ActionAsyncAggregationQuery.AlternateTimeDimensionEnum getAlternateTimeDimension()

setAlternateTimeDimension

public void setAlternateTimeDimension(ActionAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

pageSize

public ActionAsyncAggregationQuery pageSize(Integer pageSize)

The number of results per page

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

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