Package com.mypurecloud.sdk.v2.model

Class JourneyViewChart

java.lang.Object

com.mypurecloud.sdk.v2.model.JourneyViewChart

All Implemented Interfaces:

Serializable

public class JourneyViewChart
extends Object
implements Serializable

A chart within the context of the elements of the the journey view

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JourneyViewChart.GroupByTimeEnum	A time unit to group the metrics by.

Constructor Summary

Constructors

Constructor	Description
JourneyViewChart()
JourneyViewChart(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
JourneyViewChart	displayAttributes(JourneyViewChartDisplayAttributes displayAttributes)	Optional display attributes for rendering the chart
boolean	equals(Object o)
JourneyViewChartDisplayAttributes	getDisplayAttributes()
List<JourneyViewChartGroupByAttribute>	getGroupByAttributes()
Long	getGroupByMax()
JourneyViewChart.GroupByTimeEnum	getGroupByTime()
String	getId()
List<JourneyViewChartMetric>	getMetrics()
String	getName()
String	getSelfUri()
Integer	getVersion()
JourneyViewChart	groupByAttributes(List<JourneyViewChartGroupByAttribute> groupByAttributes)	A list of attributes to group the metrics by.
JourneyViewChart	groupByMax(Long groupByMax)	A maximum on the number of values being grouped by
JourneyViewChart	groupByTime(JourneyViewChart.GroupByTimeEnum groupByTime)	A time unit to group the metrics by.
int	hashCode()
JourneyViewChart	metrics(List<JourneyViewChartMetric> metrics)	A list of metrics to calculate within the chart by (aka the y axis)
JourneyViewChart	name(String name)
void	setDisplayAttributes(JourneyViewChartDisplayAttributes displayAttributes)
void	setGroupByAttributes(List<JourneyViewChartGroupByAttribute> groupByAttributes)
void	setGroupByMax(Long groupByMax)
void	setGroupByTime(JourneyViewChart.GroupByTimeEnum groupByTime)
void	setMetrics(List<JourneyViewChartMetric> metrics)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JourneyViewChart

public JourneyViewChart()

JourneyViewChart

public JourneyViewChart(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public JourneyViewChart name(String name)

getName

public String getName()

setName

public void setName(String name)

getVersion

public Integer getVersion()

groupByTime

public JourneyViewChart groupByTime(JourneyViewChart.GroupByTimeEnum groupByTime)

A time unit to group the metrics by. There is a limit on the number of groupBy properties which can be specified.

getGroupByTime

public JourneyViewChart.GroupByTimeEnum getGroupByTime()

setGroupByTime

public void setGroupByTime(JourneyViewChart.GroupByTimeEnum groupByTime)

groupByAttributes

public JourneyViewChart groupByAttributes(List<JourneyViewChartGroupByAttribute> groupByAttributes)

A list of attributes to group the metrics by. There is a limit on the number of groupBy properties which can be specified.

getGroupByAttributes

public List<JourneyViewChartGroupByAttribute> getGroupByAttributes()

setGroupByAttributes

public void setGroupByAttributes(List<JourneyViewChartGroupByAttribute> groupByAttributes)

metrics

public JourneyViewChart metrics(List<JourneyViewChartMetric> metrics)

A list of metrics to calculate within the chart by (aka the y axis)

getMetrics

public List<JourneyViewChartMetric> getMetrics()

setMetrics

public void setMetrics(List<JourneyViewChartMetric> metrics)

displayAttributes

public JourneyViewChart displayAttributes(JourneyViewChartDisplayAttributes displayAttributes)

Optional display attributes for rendering the chart

getDisplayAttributes

public JourneyViewChartDisplayAttributes getDisplayAttributes()

setDisplayAttributes

public void setDisplayAttributes(JourneyViewChartDisplayAttributes displayAttributes)

groupByMax

public JourneyViewChart groupByMax(Long groupByMax)

A maximum on the number of values being grouped by

getGroupByMax

public Long getGroupByMax()

setGroupByMax

public void setGroupByMax(Long groupByMax)

getSelfUri

public String getSelfUri()

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