Package com.mypurecloud.sdk.v2.model

Class KnowledgeAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeAggregationQuery

All Implemented Interfaces:

Serializable

public class KnowledgeAggregationQuery
extends Object
implements Serializable

KnowledgeAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeAggregationQuery()
KnowledgeAggregationQuery(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeAggregationQuery	alternateTimeDimension(KnowledgeAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)	Dimension to use as the alternative timestamp for data in the aggregate.
boolean	equals(Object o)
KnowledgeAggregationQuery	filter(KnowledgeAggregateQueryFilter filter)	Behaves like a SQL WHERE clause.
KnowledgeAggregationQuery	flattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)	Flattens any multivalued dimensions used in response groups (e.g.
KnowledgeAggregationQuery.AlternateTimeDimensionEnum	getAlternateTimeDimension()
KnowledgeAggregateQueryFilter	getFilter()
Boolean	getFlattenMultivaluedDimensions()
String	getGranularity()
List<KnowledgeAggregationQuery.GroupByEnum>	getGroupBy()
String	getInterval()
Integer	getLimit()
List<KnowledgeAggregationQuery.MetricsEnum>	getMetrics()
KnowledgeAggregationQuery.QueryTypeEnum	getQueryType()
KnowledgeAggregationSort	getSortMetric()
String	getTimeZone()
List<KnowledgeAggregationView>	getViews()
KnowledgeAggregationQuery	granularity(String granularity)	Granularity aggregates metrics into subpartitions within the time interval specified.
KnowledgeAggregationQuery	groupBy(List<KnowledgeAggregationQuery.GroupByEnum> groupBy)	Behaves like a SQL GROUPBY.
int	hashCode()
KnowledgeAggregationQuery	interval(String interval)	Behaves like one clause in a SQL WHERE.
KnowledgeAggregationQuery	limit(Integer limit)	How many results you want in an ordered list.
KnowledgeAggregationQuery	metrics(List<KnowledgeAggregationQuery.MetricsEnum> metrics)	Behaves like a SQL SELECT clause.
KnowledgeAggregationQuery	queryType(KnowledgeAggregationQuery.QueryTypeEnum queryType)	Query type to use.
void	setAlternateTimeDimension(KnowledgeAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)
void	setFilter(KnowledgeAggregateQueryFilter filter)
void	setFlattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)
void	setGranularity(String granularity)
void	setGroupBy(List<KnowledgeAggregationQuery.GroupByEnum> groupBy)
void	setInterval(String interval)
void	setLimit(Integer limit)
void	setMetrics(List<KnowledgeAggregationQuery.MetricsEnum> metrics)
void	setQueryType(KnowledgeAggregationQuery.QueryTypeEnum queryType)
void	setSortMetric(KnowledgeAggregationSort sortMetric)
void	setTimeZone(String timeZone)
void	setViews(List<KnowledgeAggregationView> views)
KnowledgeAggregationQuery	sortMetric(KnowledgeAggregationSort sortMetric)	Required when requesting multiple metrics.
KnowledgeAggregationQuery	timeZone(String timeZone)	Time zone context used to calculate response intervals (this allows resolving DST changes).
String	toString()
KnowledgeAggregationQuery	views(List<KnowledgeAggregationView> views)	Custom derived metric views

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeAggregationQuery

public KnowledgeAggregationQuery()

KnowledgeAggregationQuery

public KnowledgeAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

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

setGroupBy

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

filter

public KnowledgeAggregationQuery filter(KnowledgeAggregateQueryFilter 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 KnowledgeAggregateQueryFilter getFilter()

setFilter

public void setFilter(KnowledgeAggregateQueryFilter filter)

metrics

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

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

getMetrics

public List<KnowledgeAggregationQuery.MetricsEnum> getMetrics()

setMetrics

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

flattenMultivaluedDimensions

public KnowledgeAggregationQuery 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 KnowledgeAggregationQuery views(List<KnowledgeAggregationView> views)

Custom derived metric views

getViews

public List<KnowledgeAggregationView> getViews()

setViews

public void setViews(List<KnowledgeAggregationView> views)

alternateTimeDimension

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

setAlternateTimeDimension

public void setAlternateTimeDimension(KnowledgeAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

queryType

public KnowledgeAggregationQuery queryType(KnowledgeAggregationQuery.QueryTypeEnum queryType)

Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.

getQueryType

public KnowledgeAggregationQuery.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeAggregationQuery.QueryTypeEnum queryType)

sortMetric

public KnowledgeAggregationQuery sortMetric(KnowledgeAggregationSort sortMetric)

Required when requesting multiple metrics. Only applicable for topN/bottomN query type.

getSortMetric

public KnowledgeAggregationSort getSortMetric()

setSortMetric

public void setSortMetric(KnowledgeAggregationSort sortMetric)

limit

public KnowledgeAggregationQuery limit(Integer limit)

How many results you want in an ordered list. Only applicable for topN/bottomN query type.

getLimit

public Integer getLimit()

setLimit

public void setLimit(Integer limit)

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