Package com.mypurecloud.sdk.v2.model

Class FlowAsyncAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.FlowAsyncAggregationQuery

All Implemented Interfaces:

Serializable

public class FlowAsyncAggregationQuery
extends Object
implements Serializable

FlowAsyncAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
FlowAsyncAggregationQuery()
FlowAsyncAggregationQuery(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

FlowAsyncAggregationQuery

public FlowAsyncAggregationQuery()

FlowAsyncAggregationQuery

public FlowAsyncAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

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

setGroupBy

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

filter

public FlowAsyncAggregationQuery filter(FlowAggregateQueryFilter 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 FlowAggregateQueryFilter getFilter()

setFilter

public void setFilter(FlowAggregateQueryFilter filter)

metrics

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

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

getMetrics

public List<FlowAsyncAggregationQuery.MetricsEnum> getMetrics()

setMetrics

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

flattenMultivaluedDimensions

public FlowAsyncAggregationQuery 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 FlowAsyncAggregationQuery views(List<FlowAggregationView> views)

Custom derived metric views

getViews

public List<FlowAggregationView> getViews()

setViews

public void setViews(List<FlowAggregationView> views)

alternateTimeDimension

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

setAlternateTimeDimension

public void setAlternateTimeDimension(FlowAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

pageSize

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