Package com.mypurecloud.sdk.v2.model

Class JourneyAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.JourneyAggregationQuery

All Implemented Interfaces:

Serializable

public class JourneyAggregationQuery
extends Object
implements Serializable

JourneyAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
JourneyAggregationQuery()
JourneyAggregationQuery(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

JourneyAggregationQuery

public JourneyAggregationQuery()

JourneyAggregationQuery

public JourneyAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

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

setGroupBy

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

filter

public JourneyAggregationQuery filter(JourneyAggregateQueryFilter 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 JourneyAggregateQueryFilter getFilter()

setFilter

public void setFilter(JourneyAggregateQueryFilter filter)

metrics

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

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

getMetrics

public List<JourneyAggregationQuery.MetricsEnum> getMetrics()

setMetrics

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

flattenMultivaluedDimensions

public JourneyAggregationQuery 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 JourneyAggregationQuery views(List<JourneyAggregationView> views)

Custom derived metric views

getViews

public List<JourneyAggregationView> getViews()

setViews

public void setViews(List<JourneyAggregationView> views)

alternateTimeDimension

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

setAlternateTimeDimension

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