Package com.mypurecloud.sdk.v2.model

Class TranscriptAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.TranscriptAggregationQuery

All Implemented Interfaces:

Serializable

public class TranscriptAggregationQuery
extends Object
implements Serializable

TranscriptAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
TranscriptAggregationQuery()
TranscriptAggregationQuery(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

TranscriptAggregationQuery

public TranscriptAggregationQuery()

TranscriptAggregationQuery

public TranscriptAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

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

setGroupBy

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

filter

public TranscriptAggregationQuery filter(TranscriptAggregateQueryFilter 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 TranscriptAggregateQueryFilter getFilter()

setFilter

public void setFilter(TranscriptAggregateQueryFilter filter)

metrics

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

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

getMetrics

public List<TranscriptAggregationQuery.MetricsEnum> getMetrics()

setMetrics

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

flattenMultivaluedDimensions

public TranscriptAggregationQuery 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 TranscriptAggregationQuery views(List<TranscriptAggregationView> views)

Custom derived metric views

getViews

public List<TranscriptAggregationView> getViews()

setViews

public void setViews(List<TranscriptAggregationView> views)

alternateTimeDimension

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

setAlternateTimeDimension

public void setAlternateTimeDimension(TranscriptAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

queryType

public TranscriptAggregationQuery queryType(TranscriptAggregationQuery.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 TranscriptAggregationQuery.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(TranscriptAggregationQuery.QueryTypeEnum queryType)

sortMetric

public TranscriptAggregationQuery sortMetric(TranscriptAggregationSort sortMetric)

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

getSortMetric

public TranscriptAggregationSort getSortMetric()

setSortMetric

public void setSortMetric(TranscriptAggregationSort sortMetric)

limit

public TranscriptAggregationQuery 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