Package com.mypurecloud.sdk.v2.model

Class SocialMediaAsyncAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.SocialMediaAsyncAggregationQuery

All Implemented Interfaces:

Serializable

public class SocialMediaAsyncAggregationQuery
extends Object
implements Serializable

SocialMediaAsyncAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SocialMediaAsyncAggregationQuery.GroupByEnum	Gets or Sets groupBy
static enum	SocialMediaAsyncAggregationQuery.MetricsEnum	Gets or Sets metrics

Constructor Summary

Constructors

Constructor	Description
SocialMediaAsyncAggregationQuery()
SocialMediaAsyncAggregationQuery(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SocialMediaAsyncAggregationQuery	filter(SocialMediaQueryFilter filter)	Behaves like a SQL WHERE clause.
SocialMediaQueryFilter	getFilter()
String	getGranularity()
List<SocialMediaAsyncAggregationQuery.GroupByEnum>	getGroupBy()
String	getInterval()
List<SocialMediaAsyncAggregationQuery.MetricsEnum>	getMetrics()
Integer	getPageSize()
String	getTimeZone()
SocialMediaAsyncAggregationQuery	granularity(String granularity)	Granularity metrics into subpartitions within the time interval specified.
SocialMediaAsyncAggregationQuery	groupBy(List<SocialMediaAsyncAggregationQuery.GroupByEnum> groupBy)	Behaves like a SQL GROUPBY.
int	hashCode()
SocialMediaAsyncAggregationQuery	interval(String interval)	Behaves like one clause in a SQL WHERE.
SocialMediaAsyncAggregationQuery	metrics(List<SocialMediaAsyncAggregationQuery.MetricsEnum> metrics)	Behaves like a SQL SELECT clause.
SocialMediaAsyncAggregationQuery	pageSize(Integer pageSize)	The number of results per page
void	setFilter(SocialMediaQueryFilter filter)
void	setGranularity(String granularity)
void	setGroupBy(List<SocialMediaAsyncAggregationQuery.GroupByEnum> groupBy)
void	setInterval(String interval)
void	setMetrics(List<SocialMediaAsyncAggregationQuery.MetricsEnum> metrics)
void	setPageSize(Integer pageSize)
void	setTimeZone(String timeZone)
SocialMediaAsyncAggregationQuery	timeZone(String timeZone)	Time zone context used to calculate response intervals (this allows resolving DST changes).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SocialMediaAsyncAggregationQuery

public SocialMediaAsyncAggregationQuery()

SocialMediaAsyncAggregationQuery

public SocialMediaAsyncAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

public SocialMediaAsyncAggregationQuery 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 SocialMediaAsyncAggregationQuery granularity(String granularity)

Granularity 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 SocialMediaAsyncAggregationQuery 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 SocialMediaAsyncAggregationQuery groupBy(List<SocialMediaAsyncAggregationQuery.GroupByEnum> groupBy)

Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting computations into distinct named subgroups rather than across the entire result set as if it were one group.

getGroupBy

public List<SocialMediaAsyncAggregationQuery.GroupByEnum> getGroupBy()

setGroupBy

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

filter

public SocialMediaAsyncAggregationQuery filter(SocialMediaQueryFilter 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 SocialMediaQueryFilter getFilter()

setFilter

public void setFilter(SocialMediaQueryFilter filter)

metrics

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

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

getMetrics

public List<SocialMediaAsyncAggregationQuery.MetricsEnum> getMetrics()

setMetrics

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

pageSize

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