Package com.mypurecloud.sdk.v2.model

Class CopilotAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.CopilotAggregationQuery

All Implemented Interfaces:

Serializable

public class CopilotAggregationQuery
extends Object
implements Serializable

CopilotAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
CopilotAggregationQuery()
CopilotAggregationQuery(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

CopilotAggregationQuery

public CopilotAggregationQuery()

CopilotAggregationQuery

public CopilotAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

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

setGroupBy

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

filter

public CopilotAggregationQuery filter(CopilotAggregateQueryFilter 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 CopilotAggregateQueryFilter getFilter()

setFilter

public void setFilter(CopilotAggregateQueryFilter filter)

metrics

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

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

getMetrics

public List<CopilotAggregationQuery.MetricsEnum> getMetrics()

setMetrics

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

flattenMultivaluedDimensions

public CopilotAggregationQuery 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 CopilotAggregationQuery views(List<CopilotAggregationView> views)

Custom derived metric views

getViews

public List<CopilotAggregationView> getViews()

setViews

public void setViews(List<CopilotAggregationView> views)

alternateTimeDimension

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

setAlternateTimeDimension

public void setAlternateTimeDimension(CopilotAggregationQuery.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